---
title: "Export Search Results"
method: GET
path: "/api/v2/search/export"
tags: ["Search"]
---

# Export Search Results

`GET /api/v2/search/export`

Exports a set of results. See [Query syntax](#query-syntax) for the syntax of the `query` parameter.

Use this endpoint for search queries that will return more than 1000 results. The result set is ordered only by the `created_at` attribute.

The search only returns results of a single object type. The following object types are supported: ticket, organization, user, or group.

You must specify the type in the `filter[type]` parameter. Searches with type in the query string will result in an error.

#### Allowed For

- Agents

#### Pagination

- Cursor pagination

See [Pagination](/api-reference/introduction/pagination/).

Returns a maximum of 1000 records per page. The number of results shown in a page is determined by the `page[size]` parameter.

**Note**: You may experience a speed reduction or a timeout if you request 1000 results per page and you have many archived tickets in the results. Try reducing the number of results per page. We recommend 100 results per page.

The cursor specified by the `after_cursor` property in a response expires after one hour.

For more information on cursor-based pagination, see the following articles:

- [Comparing cursor pagination and offset pagination](/documentation/developer-tools/pagination/comparing-cursor-pagination-and-offset-pagination)
- [Paginating through lists using cursor pagination](/documentation/developer-tools/pagination/paginating-through-lists-using-cursor-pagination)

#### Limits

This API endpoint is rate-limited to 100 requests per minute per account. The limit also counts towards the global API rate limit.

#### Response Format

| Name                  | Type                 | Comment
| --------------------- | ---------------------| --------------------
| links[next]           | string               | URL to the next page of results
| meta[has_more]        | string               | Boolean indicating if there are more results
| meta[after_cursor]    | string               | Cursor object returned from the Search Service
| results               | array                | May consist of tickets, users, groups, or organizations, as specified by the `filter_type` parameter

The response is similar to the response of `GET /api/v2/search.json?`, with a few changes:

* `links` - Has the following nested properties: `prev` and `next`. These replace the `next_page` and `prev_page` links. The `prev` property is always null because backward pagination is not supported. The `next` property may include an auto-generated link to the next page of results.
* `meta` - Has the following nested properties: `has_more` and `after_cursor`. The `has_more` property indicates whether the next page has more results. The `after_cursor` property is the cursor used to paginate to the next page. It expires after one hour.

There's no `count` property.

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer
- `query` string, required
- `filter[type]` 'ticket' | 'organization' | 'user' | 'group'

## Response `200`

Success response

- SearchExportResponse
  - `facets` string, nullable — The facets corresponding to the search query
  - `links` object — The links to the previous and next entries via the cursor ids in the metadata.
    - `next` string, nullable — The url to the next entry via the cursor.
    - `prev` string, nullable — The url to the previous entry via the cursor.
  - `meta` object — Metadata for the export query response.
    - `after_cursor` string, nullable — The cursor id for the next object.
    - `before_cursor` string, nullable — The cursor id for the previous object.
    - `has_more` boolean — Whether there are more items yet to be returned by the cursor.
  - `results` SearchResultObject[] — May consist of tickets, users, groups, or organizations, as specified by the `result_type` property in each result object
    - `created_at` string — When the resource was created
    - `default` boolean — Flag to indicate whether this is the default resource
    - `deleted` boolean — Flag to indicate whether or not resource has been deleted
    - `description` string — The description of the resource
    - `id` integer — The ID of the resource
    - `name` string — The name of the resource
    - `result_type` string — The type of the resource
    - `updated_at` string — When the resource was last updated
    - `url` string — The url of the resource

## Changes

> 29 revisions in range; 1 not diffed.

- **2025-06-12** `edbf399da815` — 1 breaking, 2 warning, 1 info
  - for the `query` request parameter `page[size]`, default value `100` was added
  - for the `query` request parameter `page[size]`, the max was set to `100.00`
  - for the `query` request parameter `page[size]`, the min was set to `1.00`
  - added the new optional `query` request parameter `page[before]`

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/search/export/get.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)