User -- List

Gets company users, optionally filtering by email.

NOTE: The limit parameter has been soft-deprecated. Please omit the limit parameter, or reduce it to 100 or less.

  • Limit values of greater than 100 will only produce a page size of 100, and a 400 Bad Request response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size.

  • The cursor value is provided in the API response, and can be passed as a parameter to retrieve subsequent pages of results.

Added on March 22, 2018 for API v2.

Rate limit: 1200 per minute.

Query Params
string

A token used to return the next page of a previous request. Use the cursor provided in the previous response.

string
enum

Filter results by the specified user state (e.g. active, suspended, deleted)

Allowed:
boolean

If provided, filter results by the specified value to return only company admins or only non-company admins.

string

The user's email.

string

The user's phone number.

Response

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