Support API: Announcing the Export Search Results endpoint

Announced	Available
December 11, 2020	December 11- 15, 2020

It's with great excitement that we announce the addition of a new Support API endpoint named Export Search Results! Last year we implemented some limits to the existing List Search Results endpoint when we announced this breaking change. With your feedback, we created an alternative API to help pull data from Support beyond the 1,000 result limit. The new Export Search Results endpoint is now generally available.

What's in the release?

A new endpoint, /api/v2/search/export, is available. It uses similar searching syntax as the /api/v2/search endpoint with some slight variation. This includes using cursor based pagination as the method to retrieve all the data. This new endpoint lets you pull tickets, users, organizations, or groups with more results per page and more results in total.

This new endpoint is designed to retrieve larger results sets while using search criteria similar to the /api/v2/search endpoint. The new endpoint allows results beyond the 1,000 result limit in the /api/v2/search endpoint using a cursor-based pagination approach. With this GA, you have access to this endpoint with a limit of 100 requests per minute.

Need the filtering capabilities of search but blocked by the search 1k limits?

The new /api/v2/search/export endpoint is just what you need. This endpoint is an alternative to /api/v2/search when you need more than 1,000 results. There are some differences in how you interact with pagination and slightly different limits. The API docs have the information on limits and usage.

How can I start to use the new API?

If you have existing queries with the List Search Results endpoint, then you can use the same search criteria with the Export Search Results and pull more data. You can only choose one of the following types: ticket, user, organization, or group. Also, you can only sort by created_at date. Lastly, you'll need to paginate using cursor-based pagination. All other search criteria used previously are allowed.

If you're using this for a new implementation, follow the details in the API documentation for your particular use case.