BObotbrains-io
Users

Search Users

Changed on

Returns an array of users who meet the search criteria.

Returns up to 100 records per page to a maximum of 10,000 records per query. See Using offset pagination.

Pagination

  • Offset pagination only

See Using Offset Pagination.

Allowed For

  • Agents
get/api/v2/users/search

Request

Query parameters

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.

external_idstring

The external_id parameter does not support the search syntax. It only accepts ids.

Response

Success response

Changes

  • 9eac011b0efdRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      removed from the / response property anyOf list for the response status