younifyd
Menu

List Search Results

List Search Results

GET/api/v2/search

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the List Search Results action (under Search).
  3. Fill in the fields below, then reference the result from later steps as {{listSearchResults.response.data}}.

Request

Query parameters

querystringrequired

The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/4408886879258)

sort_bystring

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

sort_orderstring

One of `asc` or `desc`. Defaults to `desc`

includestring

Sideloads to include in the response. Accepts a comma-separated list of values. The available sideloads depend on the search result types.

Response

Returns 200 with an object. Read it in later steps with {{listSearchResults.response.data.<field>}}.

countinteger

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

facetsstring

The facets corresponding to the search query

next_pagestring

URL to the next page of results

previous_pagestring

URL to the previous page of results

resultsarray<object>

May consist of tickets, users, groups, or organizations, as specified by the `result_type` property in each result object

created_atstring

When the resource was created

defaultboolean

Flag to indicate whether this is the default resource

deletedboolean

Flag to indicate whether or not resource has been deleted

descriptionstring

The description of the resource

idinteger (int64)

The ID of the resource

namestring

The name of the resource

result_typestring

The type of the resource

updated_atstring

When the resource was last updated

urlstring

The url of the resource

json
{
  "count": 0,
  "facets": "string",
  "next_page": "string",
  "previous_page": "string",
  "results": [
    {
      "created_at": "string",
      "default": false,
      "deleted": false,
      "description": "string",
      "id": 0,
      "name": "string",
      "result_type": "string",
      "updated_at": "string",
      "url": "string"
    }
  ]
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.