OpenRows Get started
Docs menu

API reference

Airtable

5 operations, generated from the OpenAPI document.

The Airtable bases an Airtable personal access token can read (workspace creators; the token is not kept)

POST /api/workspaces/{workspaceId}/airtable/bases

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

Parameters

NameInTypeRequired
workspaceIdpathstring (uuid)yes

Request body

  • token string required

Responses

  • 200 Success
    • bases array of object required
      • id string required
      • name string required
      • permissionLevel string 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)

The Airtable imports the caller started in the workspace (the last 7 days)

GET /api/workspaces/{workspaceId}/airtable/imports

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

Parameters

NameInTypeRequired
workspaceIdpathstring (uuid)yes

Responses

  • 200 Success
    • imports array of object required
      • id string (uuid) required
      • baseId string (uuid) required
      • airtableBaseId string required
      • name string required
      • status "running" | "done" | "failed" | "cancelled" required
      • phase "schema" | "records" | "links" required
      • tables integer required
      • tablesDone integer required
      • records integer required
      • attachments integer required
      • attachmentsFailed integer required
      • linkedRecords integer required
      • percent integer required
      • report object required
        • tables array of object required
          • name string required
          • tableId string (uuid) required
          • fields integer required
          • records integer required
        • unsupportedFields array of object required
          • table string required
          • field string required
          • type string required
          • message string required
        • untranslatedFormulas array of object required
          • table string required
          • field string required
          • type string required
          • message string required
          • formula string required
        • converted array of object required
          • table string required
          • field string required
          • type string required
          • message string required
        • skippedCells integer required
        • truncatedTables array of string required
        • failedAttachments array of object required
          • table string required
          • field string required
          • filename string required
          • message string required
        • skippedLinks integer required
        • views integer required
        • unsupportedViews array of object required
          • table string required
          • view string required
          • type string required
          • message string required
      • error string | null required
      • createdAt string required
      • startedAt string | null 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)

Import Airtable bases into new bases of the workspace, in the background

POST /api/workspaces/{workspaceId}/airtable/imports

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

Parameters

NameInTypeRequired
workspaceIdpathstring (uuid)yes

Request body

  • token string required
  • baseIds array of string required

Responses

  • 201 Success
    • imports array of object required
      • id string (uuid) required
      • baseId string (uuid) required
      • airtableBaseId string required
      • name string required
      • status "running" | "done" | "failed" | "cancelled" required
      • phase "schema" | "records" | "links" required
      • tables integer required
      • tablesDone integer required
      • records integer required
      • attachments integer required
      • attachmentsFailed integer required
      • linkedRecords integer required
      • percent integer required
      • report object required
        • tables array of object required
          • name string required
          • tableId string (uuid) required
          • fields integer required
          • records integer required
        • unsupportedFields array of object required
          • table string required
          • field string required
          • type string required
          • message string required
        • untranslatedFormulas array of object required
          • table string required
          • field string required
          • type string required
          • message string required
          • formula string required
        • converted array of object required
          • table string required
          • field string required
          • type string required
          • message string required
        • skippedCells integer required
        • truncatedTables array of string required
        • failedAttachments array of object required
          • table string required
          • field string required
          • filename string required
          • message string required
        • skippedLinks integer required
        • views integer required
        • unsupportedViews array of object required
          • table string required
          • view string required
          • type string required
          • message string required
      • error string | null required
      • createdAt string required
      • startedAt string | null 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 Airtable import's progress and report (only who started it)

GET /api/workspaces/{workspaceId}/airtable/imports/{importId}

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

Parameters

NameInTypeRequired
workspaceIdpathstring (uuid)yes
importIdpathstring (uuid)yes

Responses

  • 200 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • airtableBaseId string required
    • name string required
    • status "running" | "done" | "failed" | "cancelled" required
    • phase "schema" | "records" | "links" required
    • tables integer required
    • tablesDone integer required
    • records integer required
    • attachments integer required
    • attachmentsFailed integer required
    • linkedRecords integer required
    • percent integer required
    • report object required
      • tables array of object required
        • name string required
        • tableId string (uuid) required
        • fields integer required
        • records integer required
      • unsupportedFields array of object required
        • table string required
        • field string required
        • type string required
        • message string required
      • untranslatedFormulas array of object required
        • table string required
        • field string required
        • type string required
        • message string required
        • formula string required
      • converted array of object required
        • table string required
        • field string required
        • type string required
        • message string required
      • skippedCells integer required
      • truncatedTables array of string required
      • failedAttachments array of object required
        • table string required
        • field string required
        • filename string required
        • message string required
      • skippedLinks integer required
      • views integer required
      • unsupportedViews array of object required
        • table string required
        • view string required
        • type string required
        • message string required
    • error string | null required
    • createdAt string required
    • startedAt string | null 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)

Stop a running Airtable import (only who started it); the new base keeps what was imported

POST /api/workspaces/{workspaceId}/airtable/imports/{importId}/cancel

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

Parameters

NameInTypeRequired
workspaceIdpathstring (uuid)yes
importIdpathstring (uuid)yes

Responses

  • 200 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • airtableBaseId string required
    • name string required
    • status "running" | "done" | "failed" | "cancelled" required
    • phase "schema" | "records" | "links" required
    • tables integer required
    • tablesDone integer required
    • records integer required
    • attachments integer required
    • attachmentsFailed integer required
    • linkedRecords integer required
    • percent integer required
    • report object required
      • tables array of object required
        • name string required
        • tableId string (uuid) required
        • fields integer required
        • records integer required
      • unsupportedFields array of object required
        • table string required
        • field string required
        • type string required
        • message string required
      • untranslatedFormulas array of object required
        • table string required
        • field string required
        • type string required
        • message string required
        • formula string required
      • converted array of object required
        • table string required
        • field string required
        • type string required
        • message string required
      • skippedCells integer required
      • truncatedTables array of string required
      • failedAttachments array of object required
        • table string required
        • field string required
        • filename string required
        • message string required
      • skippedLinks integer required
      • views integer required
      • unsupportedViews array of object required
        • table string required
        • view string required
        • type string required
        • message string required
    • error string | null required
    • createdAt string required
    • startedAt string | null 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)