GET /api/v2/users
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
100will only produce a page size of100, and a400 Bad Requestresponse 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
cursorvalue 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.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | No |
The user's email. |
company_admin |
Boolean | No |
If provided, filter results by the specified value to return only company admins or only non-company admins. |
number |
String | No |
The user's phone number. |
state |
String | No |
Filter results by the specified user state (e.g. active, suspended, deleted) Possible values:
|
cursor |
String | No |
A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.