Get base

Get a base by baseId

GET /base/{baseId}

cURL

cURL

curl --request GET \
  --url https://app.teable.ai/api/base/%7BbaseId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "id": "<string>",
  "name": "<string>",
  "spaceId": "<string>",
  "icon": "<string>",
  "role": "owner",
  "createdBy": "<string>",
  "collaboratorType": "space",
  "restrictedAuthority": true,
  "enabledAuthority": true,
  "lastModifiedTime": "<string>",
  "createdTime": "<string>",
  "isCanary": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

baseId · string · required

Response

200 - application/json

Returns information about a base.

id · string · required

name · string · required

spaceId · string · required

icon · string | null · required

role · enum<string> · required

Available options: owner, creator, editor, commenter, viewer

createdBy · string · required

collaboratorType · enum<string>

Available options: space, base

restrictedAuthority · boolean

enabledAuthority · boolean

lastModifiedTime · string | null

createdTime · string | null

template · object

Show child attributes

createdUser · object

Show child attributes

isCanary · boolean