Imports

Import a CSV (up to 50 MB) into the table, in the background

POST /api/tables/{tableId}/imports

Access: record:create on the table (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• csv string required
• delimiter "," | ";" | "\t" | "|"
• hasHeader boolean
• typecast boolean
• columns array of object required
  • index integer required
  • fieldId string (uuid)
  • newField object
    • name string required
    • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
    • options object

Responses

• 201 Success
  • id string (uuid) required
  • tableId string (uuid) required
  • status "running" | "done" | "failed" required
  • totalRows integer required
  • processedRows integer required
  • skippedCells integer required
  • createdFieldIds array of string (uuid) required
  • error string | null required
  • createdAt string required
  • finishedAt string | null required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

An import's progress (only who started it)

GET /api/tables/{tableId}/imports/{importId}

Access: record:create on the table (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • id string (uuid) required
  • tableId string (uuid) required
  • status "running" | "done" | "failed" required
  • totalRows integer required
  • processedRows integer required
  • skippedCells integer required
  • createdFieldIds array of string (uuid) required
  • error string | null required
  • createdAt string required
  • finishedAt string | null required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)