# List exports

`GET https://api.cademi.com.br/api/v3/exports`

Operation ID: `exports.list` · API v3

Lists the exports of the current account using cursor-based pagination. The collection can be filtered by `resource`.

Exports never include a download URL. To download a file, request a short-lived download link for its `file_id` from the files API.

Required permissions: `exports.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `id`, `-id` | no |  |
| `resource` | query | string, one of `users`, `user_activity` | no |  |

## Responses

### 200

Returns the collection of exports.

Body: `data`: array of Export.

Fields of Export:

| Field | Type | Required | Description |
|---|---|---|---|
| `columns` | array of string | yes |  |
| `consistency` | object | yes | Exports are point-in-time snapshots. Indicates the moment the data was captured. |
| `created_at` | string (date-time) | yes |  |
| `expires_at` | string or null (date-time) | yes |  |
| `failure_reason` | string or null | yes |  |
| `file_id` | string or null | yes | Public ID of the generated file, prefixed with file_. |
| `filters` | object | yes | Requested filters, using the same names as the filters of the list users operation. Every key is always present; filters that were not requested are null. |
| `id` | string | yes | Public ID of the export, prefixed with exp_. |
| `object` | string, one of `export` | yes |  |
| `operation_id` | string or null | yes | Public ID of the operation that generates the file, prefixed with op_. |
| `resource` | string or null, one of `users`, `user_activity` | yes |  |
| `status` | string, one of `queued`, `processing`, `completed`, `failed`, `expired` | yes |  |
| `total` | integer or null | yes |  |

### 400

The cursor is invalid or the request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

Full schema: https://cademi.dev/openapi/v3.json