BObotbrains-io
Search

List Search Results

Returns the search results. See Query basics for the syntax of 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.

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:

NameTypeComment
errorstringThe type of error. Examples: "unavailable", "invalid"
descriptionstring
Example Error
{
  "error": "unavailable",
  "description": "Sorry, we could not complete your search query. Please try again in a moment."
}
get/api/v2/search

Request

Query parameters

querystring required

The search query. See Query basics above. For details on the query syntax, see the Zendesk Support search reference

sort_by'updated_at' | 'created_at' | 'priority' | 'status' | 'ticket_type'

One of updated_at, created_at, priority, status, or ticket_type. Defaults to sorting by relevance

sort_order'asc' | 'desc'

One of asc or desc. Defaults to desc

pageinteger

Page number for offset pagination

per_pageinteger

Number of items per page

Response

Success response

countinteger

The number of resources returned by the query corresponding to this page of results in the paginated response

facetsstring nullable

The facets corresponding to the search query

next_pagestring nullable

URL to the next page of results

previous_pagestring nullable

URL to the previous page of results

Changes

No operation changes recorded.