Qodex.ai

Search Users

GET {{baseUrl}}/api/v2/users/search?query={{query}}

Returns an array of users who meet the search criteria.

Pagination

  • Offset pagination only

See Using Offset Pagination.

Allowed For

  • Admins, Agents and Light Agents

Request Params

KeyDatatypeRequiredDescription
querystringThe 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.
external_idstringThe external_id parameter does not support the search syntax. It only accepts ids.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"users":[{"id":35436,"name":"Robert Jones","notes":"sigil issue"},{"id":9873843,"name":"Terry Gilliam"}]}