Search tickets, users and organizations

Search tickets, users and organizations

Returns the tickets, users, organizations or groups that match a query in Zendesk's search syntax.

Narrow the query by type and field, such as type:ticket status:open or type:user, and add sort_by and sort_order to order the results. It returns at most 1,000 results per query and 100 per page; for more, use the Export Search Results endpoint, GET /api/v2/search/export.

Set up

Use the first option your agent supports.

API (official)

• Base URL: https://{subdomain}.zendesk.com
• Endpoint: GET /api/v2/search?query={query}
• Auth: send the header Authorization: Bearer $ZENDESK_OAUTH_TOKEN
• Get a key: https://developer.zendesk.com/documentation/authentication/oauth-migration/#getting-your-first-token
• Docs: https://developer.zendesk.com/api-reference/ticketing/introduction/

Before doing anything else, make one read-only call to confirm access.

Rules

• Ask the user before anything that sends messages, costs money, or changes data.
• Never print API keys.