OpenRows Get started
Docs menu

API reference

Tables

6 operations, generated from the OpenAPI document.

The tables of a base

GET /api/bases/{baseId}/tables

Access: base:read on the base (see ACTIONS for the minimum role); personal access tokens need schema.bases:read.

Parameters

NameInTypeRequired
baseIdpathstringyes

Responses

  • 200 Success
    • tables array of object required
      • id string (uuid) required
      • baseId string (uuid) required
      • name string required
      • description string | null required
      • icon string | null required
      • position number required
      • schemaVersion integer required
      • permissions object
        • addRecords object required
        • deleteRecords object required
        • editRecords object required
      • synced true
      • createdAt string (date-time) required
      • updatedAt string (date-time) 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)

Create a table with the default fields and a grid view

POST /api/bases/{baseId}/tables

Access: table:create on the base (see ACTIONS for the minimum role); personal access tokens need schema.bases:write.

Parameters

NameInTypeRequired
baseIdpathstringyes

Request body

  • name string required
  • description string
  • icon string
  • primaryFieldName string

Responses

  • 201 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • position number required
    • schemaVersion integer required
    • permissions object
      • addRecords object required
      • deleteRecords object required
      • editRecords object required
    • fields array of object required
      • id string (uuid) required
      • tableId string (uuid) required
      • name string required
      • description string | null required
      • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
      • options any required
      • isPrimary boolean required
      • position number required
      • permissions object
        • edit object required
        • allowForms boolean
      • createdAt string (date-time) required
      • updatedAt string (date-time) required
      • deletedAt string (date-time) | null required
      • recomputing true
      • synced true
    • synced true
    • createdAt string (date-time) required
    • updatedAt string (date-time) 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)

Read a table with its live fields

GET /api/tables/{tableId}

Access: table:read on the table (see ACTIONS for the minimum role); personal access tokens need schema.bases:read.

Parameters

NameInTypeRequired
tableIdpathstringyes

Responses

  • 200 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • position number required
    • schemaVersion integer required
    • permissions object
      • addRecords object required
      • deleteRecords object required
      • editRecords object required
    • fields array of object required
      • id string (uuid) required
      • tableId string (uuid) required
      • name string required
      • description string | null required
      • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
      • options any required
      • isPrimary boolean required
      • position number required
      • permissions object
        • edit object required
        • allowForms boolean
      • createdAt string (date-time) required
      • updatedAt string (date-time) required
      • deletedAt string (date-time) | null required
      • recomputing true
      • synced true
    • synced true
    • createdAt string (date-time) required
    • updatedAt string (date-time) 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)

Rename, describe or reorder a table

PATCH /api/tables/{tableId}

Access: table:update on the table (see ACTIONS for the minimum role); personal access tokens need schema.bases:write.

Parameters

NameInTypeRequired
tableIdpathstringyes

Request body

  • name string
  • description string | null
  • icon string | null
  • position number
  • permissions object
    • addRecords object
    • deleteRecords object
    • editRecords object

Responses

  • 200 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • position number required
    • schemaVersion integer required
    • permissions object
      • addRecords object required
      • deleteRecords object required
      • editRecords object required
    • fields array of object required
      • id string (uuid) required
      • tableId string (uuid) required
      • name string required
      • description string | null required
      • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
      • options any required
      • isPrimary boolean required
      • position number required
      • permissions object
        • edit object required
        • allowForms boolean
      • createdAt string (date-time) required
      • updatedAt string (date-time) required
      • deletedAt string (date-time) | null required
      • recomputing true
      • synced true
    • synced true
    • createdAt string (date-time) required
    • updatedAt string (date-time) 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)

Move a table to the trash

DELETE /api/tables/{tableId}

Access: table:delete on the table (see ACTIONS for the minimum role); personal access tokens need schema.bases:write.

Parameters

NameInTypeRequired
tableIdpathstringyes

Responses

  • 204 Success, no content
  • 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)

Duplicate a table (structure, optionally records)

POST /api/tables/{tableId}/duplicate

Access: table:duplicate on the table (see ACTIONS for the minimum role); personal access tokens need schema.bases:write.

Parameters

NameInTypeRequired
tableIdpathstringyes

Request body

  • name string
  • includeRecords boolean

Responses

  • 201 Success
    • id string (uuid) required
    • baseId string (uuid) required
    • name string required
    • description string | null required
    • icon string | null required
    • position number required
    • schemaVersion integer required
    • permissions object
      • addRecords object required
      • deleteRecords object required
      • editRecords object required
    • fields array of object required
      • id string (uuid) required
      • tableId string (uuid) required
      • name string required
      • description string | null required
      • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
      • options any required
      • isPrimary boolean required
      • position number required
      • permissions object
        • edit object required
        • allowForms boolean
      • createdAt string (date-time) required
      • updatedAt string (date-time) required
      • deletedAt string (date-time) | null required
      • recomputing true
      • synced true
    • synced true
    • createdAt string (date-time) required
    • updatedAt string (date-time) 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)