Search Zendesk Users
search_usersFind Zendesk users by name, email, role, or organization using search query syntax. Returns the total count and supports paginated results.
Instructions
Search for users by name, email, or other criteria using Zendesk search query syntax. Returns total count.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number for offset pagination. Increment it while keeping `per_page` fixed to fetch subsequent pages; page 1 is the first page. | |
| query | Yes | Zendesk user search query — free text matched against name and email, and/or field filters like "email:jane@acme.com", "role:agent", "organization_id:123". A "type:user" scope is added automatically. | |
| per_page | No | Number of results per page for offset pagination (1-100). Pair with `page` to walk large result sets; the response header reports the total count and whether more pages remain. |