GET /api/v2/users
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Admins, Agents and Light Agents
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
external_id |
String | No |
List users by external id. External id has to be unique for each user under the same account. |
permission_set |
Integer | No |
For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request |
role |
String | No |
Filters the results by role. Possible values are "end-user", "agent", or "admin" Possible values:
|
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.