GET /api/v2/search
Returns the search results. See Query syntax for details on the query parameter.
Use the ampersand character (&) to append the sort_by or sort_order parameters to the URL.
For examples, see Searching with Zendesk API.
This endpoint has its own rate limit. The rate limit counts towards the global API rate limit. See Limits.
Allowed For
- Agents
Pagination
- Offset pagination only
Offset pagination may result in duplicate results when paging. You can also use the Export Search Results endpoint, which uses cursor-based pagination and doesn't return duplicate results. See Using cursor pagination for more information.
Errors JSON Format
Errors are represented as JSON objects which have the following keys:
| Name | Type | Comment |
|---|---|---|
| error | string | The type of error. Examples: "unavailable", "invalid" |
| description | string |
Example Error
{
"error": "unavailable",
"description": "Sorry, we could not complete your search query. Please try again in a moment."
}
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
query |
String | Yes |
The search query. See Query basics above. For details on the query syntax, see the Zendesk Support search reference |
sort_order |
String | No |
One of |
sort_by |
String | No |
One of |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.