Developers
Imports10

List imports

GET/imports

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.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
type?string

Only imports of this type.

status?string

Only imports with this status.

Value in

  • "pending"
  • "analyzed"
  • "processing"
  • "processed"
  • "failed"
created_after?string

Only items created after this date and time (ISO 8601).

Formatdate-time
created_before?string

Only items created before this date and time (ISO 8601).

Formatdate-time
deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/imports"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "current_operation_id": "string",      "deleted": true,      "duplicate_policy": "skip",      "failure_reason": "string",      "file_id": "string",      "id": "string",      "mapping": {        "email": "string",        "product_external_id": "string",        "status": "string"      },      "object": "import",      "revision": "string",      "rows": {        "ignored": 0,        "not_ready": 0,        "ready": 0,        "total": 0      },      "status": "pending",      "type": "students_access",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Imports10

Imports in API v3: list imports, create an import, retrieve an import, update an import, delete an import, analyze an import, list processing attempts, create a processing attempt, retrieve a processing attempt, list import rows.

Create an import POST

Creates a user import from a spreadsheet that was previously uploaded with `purpose=import`. Creating an import does not process any rows. Request an analysis next, then start a processing attempt once the analysis is complete. If imports are disabled for the current account, the request is rejected with the `feature_disabled` error code.