API Reference

Search Users

post
https://api.whippy.co/v1/users/search

Search Users in the current organization with applicable filters. Optionally,offset and limit can be specified to control pagination.

Params/Filters for searching users are:

  • name - search by name, case insensitive, partial match
  • email - search by email, case insensitive, complete match
  • phone - search by phone number, complete match
  • role - search by role, case insensitive, complete match
  • state - search by state, case insensitive, complete match
  • limit - sets the number of records to return
  • offset - sets the number of records to skip
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Search User Params

Parameters for searching and filtering users.

string

User's email address

integer
Defaults to 50

Number of results to return

string

User's name

integer
Defaults to 0

Number of results to skip

string

User's phone number

string

User's role in the system

string

User's account state

Responses

Callback

Updated 16 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago