Skip to main content
This section helps you start using the Teable API quickly and safely.

​
Base URL

  • Teable Cloud: https://app.teable.ai
  • Self-hosted: use your own domain (for example https://teable.example.com)
All API paths in this documentation are relative to the base URL and start with /api.

​
Authentication

Teable APIs use Bearer tokens: 
curl -H 'Authorization: Bearer __token__' \
  'https://app.teable.ai/api/table/__tableId__/record'
You can use either:
  • Personal Access Token: best for scripts, internal tools, and server-side integrations. See Access Token.
  • OAuth Access Token: best for multi-tenant integrations where end users grant access. See OAuth App.

​
IDs (spaceId / baseId / tableId / viewId / fieldId / recordId)

Most endpoints require IDs like tbl..., rec.... See Getting IDs.

​
Scopes & permissions

Both Personal Access Tokens and OAuth tokens are permission-scoped. If you get a 403, it usually means the token is missing the required scope.

​
Pagination (take / skip)

Many list endpoints support:
  • take: number of items to return (some endpoints cap this, e.g. records max 1000)
  • skip: number of items to skip

​
Field keys & cell format

Some APIs let you control how record fields are represented:
  • fieldKeyType: name (default) / id / dbFieldName
  • cellFormat: json (default) / text
For record field value structures, see Record Field Interface.

​
Where to go next