pageinteger
Page number for offset-based pagination (non-negative integer).
per_pageinteger
Number of records to return per page.
Note: Default and maximum values vary by endpoint. Check endpoint-specific
documentation for limits.
querystring
The `query` parameter supports the Zendesk search syntax for more advanced
user searches. It can specify a partial or full value of any
user property, including name, email address, notes, or phone. Example:
`query="jdoe"`.
See the [Search API](/api-reference/ticketing/ticket-management/search/).
external_idstring
The `external_id` parameter does not support the search syntax. It only accepts ids.
brand_idoneOf
When brand separation is enabled, scopes the search to users belonging to
the specified brand. Only applicable when the account has brand separation enabled.
Accepted values:
* "all" — search all users across all brands (no brand filtering applied).
* 0 — restrict the search to account-scoped (brand-less) users only.
* A numeric brand id — if the brand has user separation enabled, search
returns only end users belonging to that brand. Unlike the list, count, and show_many endpoints,
agents and admins are not included in the results when filtering by a
specific brand. If the brand does not have user separation enabled, the
request falls back to account scope (0).
includestring
A comma-separated list of sideloads to include in the response.
