# Retrieve an export

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

Operation ID: `exports.get` · API v3

Retrieves an export by its public ID.

When generation finishes, `status` becomes `completed` and the response includes `file_id`, `total`, and `expires_at`. If generation fails, `status` becomes `failed` and `failure_reason` describes the cause.

Generated files are retained for 7 days. After that, `status` becomes `expired` and `file_id` is `null`.

The export never includes a download URL. To download the file, request a download link for `file_id` from the files API.

Required permissions: `exports.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `export_id` | path | string | yes |  |

## Responses

### 200

Returns the requested export.

Body: `data`: 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 |  |

### 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.

### 404

The export was not found or is not accessible with the current credentials.

Body: Error.

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