List Users
GET {{baseUrl}}/api/v2/users?role=<string>&role[]=<string>&permission_set=<integer>&external_id=<string>
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Admins, Agents and Light Agents
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
role | string | Filters the results by role. Possible values are "end-user", "agent", or "admin" | |
role[] | string | Filters the results by more than one role using the format role[]={role}&role[]={role} | |
permission_set | string | For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request | |
external_id | string | List users by external id. External id has to be unique for each user under the same account. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"users":[{"id":223443,"name":"Johnny Agent"},{"id":8678530,"name":"James A. Rosen"}]}