# List imports

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

Operation ID: `imports.list` · API v3

Returns user imports created from spreadsheets, using cursor-based pagination.

Imports in the trash are excluded by default. Set `deleted=true` to list them.

The `rows` summary of each import reflects its analysis. To follow the processing state of individual rows, use the list import rows operation.

Required permissions: `imports.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `sort` | query | string, one of `id`, `-id` | no |  |
| `type` | query | string | no |  |
| `status` | query | string, one of `pending`, `analyzed`, `processing`, `processed`, `failed` | no |  |
| `created_after` | query | string (date-time) | no |  |
| `created_before` | query | string (date-time) | no |  |
| `deleted` | query | boolean | no |  |

## Responses

### 200

Returns the collection of imports.

Body: `data`: array of Import.

Fields of Import:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `current_operation_id` | string or null | yes | Public ID of the operation in progress on the import, prefixed with op_. |
| `deleted` | boolean | yes |  |
| `duplicate_policy` | string, one of `skip`, `update` | yes |  |
| `failure_reason` | string or null | yes | Reason the file as a whole was rejected, such as an unreadable spreadsheet, a missing column, or exceeding the allowed limit. Does not cover errors in individual rows. |
| `file_id` | string or null | yes | Public ID of the source file, prefixed with file_. |
| `id` | string | yes | Public ID of the import, prefixed with imp_. |
| `mapping` | object | yes | Fixed spreadsheet column mapping. Read-only in this API version. |
| `object` | string, one of `import` | yes |  |
| `revision` | string | yes |  |
| `rows` | object | yes | Row counts from the analysis. All values are zero until the analysis has run. |
| `status` | string, one of `pending`, `analyzed`, `processing`, `processed`, `failed` | yes |  |
| `type` | string, one of `students_access` | yes |  |
| `updated_at` | string (date-time) | 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