younifyd
Menu

Export Search Results

Export Search Results

GET/api/v2/search/export

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the Export Search Results action (under Search).
  3. Fill in the fields below, then reference the result from later steps as {{exportSearchResults.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)

page[size]integer

The number of results shown in a page.

page[after]string

The cursor token for fetching the next page of results.

filter[type]string

The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`.

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 {{exportSearchResults.response.data.<field>}}.

facetsstring

The facets corresponding to the search query

linksobject

The links to the previous and next entries via the cursor ids in the metadata.

nextstring

The url to the next entry via the cursor.

prevstring

The url to the previous entry via the cursor.

metaobject

Metadata for the export query response.

after_cursorstring

The cursor id for the next object.

before_cursorstring

The cursor id for the previous object.

has_moreboolean

Whether there are more items yet to be returned by the cursor.

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
{
  "facets": "string",
  "links": {
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "after_cursor": "string",
    "before_cursor": "string",
    "has_more": false
  },
  "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.