Describe base

GET

/api/v1/bases/{baseId}

curl --request GET \
  --url https://api.cloudtable.insurge.io/api/v1/bases/example \
  --header 'x-api-key: <x-api-key>'

• CloudTable

The base’s tables, each with its fields and views — everything needed to read/write it, in one call.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

baseId

required

string

Responses

200

Base schema

Media typeapplication/json

object

id

required

string

name

required

string

tables

required

Array<object>

object

id

required

string

name

required

string

fields

required

Array<object>

object

id

required

string

name

required

string

type

required

string

isPrimary

required

boolean

order

required

number

options

Array<string>

linkedTableId

string

views

required

Array<object>

object

id

required

string

name

required

string

type

required

string

config

required

object

key

additional properties

nullable

Example^generated

{
  "id": "example",
  "name": "example",
  "tables": [
    {
      "id": "example",
      "name": "example",
      "fields": [
        {
          "id": "example",
          "name": "example",
          "type": "example",
          "isPrimary": true,
          "order": 1,
          "options": [
            "example"
          ],
          "linkedTableId": "example"
        }
      ],
      "views": [
        {
          "id": "example",
          "name": "example",
          "type": "example",
          "config": {
            "additionalProperty": "example"
          }
        }
      ]
    }
  ]
}

401

Unauthorized

404

Not found