List Users
Changed onPagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Admins, Agents and Light Agents
Request
- Base URLhttps://example.zendesk.com
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
Specifies how many records should be returned in the response. You can specify up to 100 records per page.
Filters the results by role. Possible values are "end-user", "agent", or "admin"
Filters the results by more than one role using the format role[]={role}&role[]={role}
For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
List users by external id. External id has to be unique for each user under the same account.
Response
Success response
Changes
- breaking
added to the
/response propertyoneOflist for the response status - info
removed from the
/response propertyanyOflist for the response status
- breaking
- info
added the new optional
queryrequest parameterpage[before]
- info