{ "opencollection": "1.0.0", "info": { "name": "Zendesk Account Account Settings Search API", "version": "1.0" }, "items": [ { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Zendesk Get Api V2 Search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/search", "params": [ { "name": "query", "value": "https://subdomain.zendesk.com/api/v2/search.json?query=type:ticket status:closed&sort_by=status&sort_order=desc", "type": "query", "description": "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/203663226)" }, { "name": "sort_by", "value": "", "type": "query", "description": "One of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance" }, { "name": "sort_order", "value": "", "type": "query", "description": "One of `asc` or `desc`. Defaults to `desc`" } ] }, "docs": "Returns the search results. See [Query basics](#query-basics) for the syntax of the `query` parameter.\n\nUse the ampersand character (&) to append the `sort_by` or `sort_order` parameters to the URL.\n\nFor examples, see [Searching with Zendesk API](/documentation/ticketing/using-the-zendesk-api/searching-with-the-zendesk-api).\n\n#### Allowed For\n\n* Agents\n\n#### Pagination\n\n* Offset pagination only\n\nOffset pagination may result in duplicate results when paging. You can also use the\n[Export Search Re" }, { "info": { "name": "Zendesk Get Api V2 Search Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/search/count", "params": [ { "name": "query", "value": "https://subdomain.zendesk.com/api/v2/search.json?query=type:ticket status:closed", "type": "query", "description": "The search query" } ] }, "docs": "Returns the number of items matching the query rather than the items. The search string works the same as a regular search.\n\n#### Allowed For\n\n- Agents\n" }, { "info": { "name": "Zendesk Get Api V2 Search Export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/search/export", "params": [ { "name": "query", "value": "https://subdomain.zendesk.com/api/v2/search.json?query=type:ticket status:closed&sort_by=status&sort_order=desc", "type": "query", "description": "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/203663226)" }, { "name": "page[size]", "value": "", "type": "query", "description": "The number of results shown in a page." }, { "name": "filter[type]", "value": "", "type": "query", "description": "The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`." } ] }, "docs": "Exports a set of results. See [Query syntax](#query-syntax) for the syntax of the `query` parameter.\n\nUse this endpoint for search queries that will return more than 1000 results. The result set is ordered only by the `created_at` attribute.\n\nThe search only returns results of a single object type. The following object types are supported: ticket, organization, user, or group.\n\nYou must specify the type in the `filter[type]` parameter. Searches with type in the query string will result in an err" } ] } ], "bundled": true }