rolestring
Filters the results by role. Possible values are "end-user", "agent", "admin", or a custom role name
role[]array<string>
Filters the results by more than one role using the format `role[]={role}&role[]={role}`
permission_setinteger (int64)
For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
external_idstring
List users by external id. External id has to be unique for each user under the same account.
includestring
Sideloads to include in the response. Accepts a comma-separated list of values.
See [Sideloading](/api-reference/ticketing/users/users/#sideloading).
pageoneOf
Pagination parameter. Supports both traditional offset and cursor-based pagination:
- Traditional: `?page=2` (integer page number)
- Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)
These are mutually exclusive - use one format or the other, not both.
per_pageinteger
Number of records to return per page.
Note: Default and maximum values vary by endpoint. Check endpoint-specific
documentation for limits.
sortstring
Field to sort results by. Prefix with `-` for descending order.
When used with cursor pagination, this determines the cursor ordering.
Example: `?sort=name` or `?sort=-created_at`
include_boundary_indicatorsboolean
When true, includes `has_more` indicator in the cursor pagination response meta.
Only valid with cursor pagination (page[size], page[after], page[before]).
include_item_cursorsboolean
When true, includes cursor values for each item in the cursor pagination response.
Only valid with cursor pagination (page[size], page[after], page[before]).
brand_idoneOf
When brand separation is enabled, scopes the listing to users belonging to
the specified brand. Only applicable when the account has brand separation enabled.
Accepted values:
* "all" — return all users across all brands (no brand filtering applied).
* 0 — return only account-scoped (brand-less) users.
* A numeric brand id — if the brand has user separation enabled, return
end users belonging to that brand plus all agents and admins (who are
account-level and always included). If the brand does not have user
separation enabled, the request falls back to account scope (0).
