Back to ZendeskSearch Users
Returns an array of users who meet the search criteria.
Pagination
See Using Offset Pagination.
Allowed For
- Admins, Agents and Light Agents
Input
type: object
properties:
parameters:
type: object
properties:
Accept:
type: string
query:
type: string
description: >
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_id:
type: string
description: >
The `external_id` parameter does not support the search syntax. It
only accepts ids.
title: Parameters
Output
type: object