REST API overview

What the Tadabase REST API can do, its base URLs, which plans include it, its rate limits, and where each part of the API is documented.

  • Verified Nov 17, 2026
  • Classic builder
  • Available on: Business Starter, Business Growth, Business Pro, Business Elite

On this page
  1. Base URLs and versions
  2. What the API covers
  3. Whose access a call has
  4. Plans and rate limits

The REST API lets your own code, scripts and other systems work with a Tadabase app: read and change records, look up tables and fields, run workflows, imports, exports and PDFs, and read logs. Every call is made with an API key you create in the app's settings.

Base URLs and versions #

VersionBase URLHow the app is named
v1https://api.tadabase.io/api/v1In the X-Tadabase-App-id header
v1.1https://api.tadabase.io/api/v1.1/{appId}In the URL

Every v1 endpoint also works under v1.1. Version 1.1 adds app user sign-in, pages and components, layouts, imports, exports, and PDF pages and forms. Requests and responses are JSON. A successful response has "type": "success"; a refused one has "type": "error" and a msg that says why.

Every call sends the key in the X-Tadabase-App-Key and X-Tadabase-App-Secret headers. A v1 call also sends the app ID in X-Tadabase-App-id; a v1.1 call has it in the URL instead. See Create and manage API keys.

What the API covers #

Each area needs its own permission on the API key. A key without it is refused, in most areas with a 412 error that says "The method being used is disabled for this API key."

AreaWhat you can doKey permissionRead more
Key checkCheck that a key works and see its permissions and remaining limits (GET status).NoneCreate and manage API keys
Tables, fields and rolesList tables, a table's fields with their slugs and types, full field settings, and user roles.Allow ReadsTables and fields API
RecordsList, get, create, update and delete records.Allow Reads, Allow Updates, Allow DeleteWorking with records
FilteringFind records that match conditions, including nested groups.Allow ReadsFiltering records
Sorting and pagesSort results and page through them, at most 100 records per page.Allow ReadsSorting and pagination
Field valuesHow each field type's values are sent and returned.Field types reference
App user sign-in (v1.1)Sign an app user in, check or end their token, create a magic link.None; magic links need Magic LinkSign in app users through the API
Pages and components (v1.1)List pages and their components, read a component's records, save a record through a form component.Allow PagePages and components API
Layouts (v1.1)List the app's layouts.Allow LayoutsPages and components API
Imports and exports (v1.1)Run import and export templates and check their progress. Business Pro and Elite plans only.Allow Import, Allow ExportImports and exports API
PDFs (v1.1)Create a PDF from a PDF page or a PDF form.Allow PDF Page, Allow PDF FormPDF generation API
WorkflowsList workflows, run one (optionally for one record), check its status and history, and stop a run.Allow WorkflowsRun workflows through the API
TasksList tasks, run one, check its status and history, and stop it.Allow TasksRun workflows through the API
EquationsRecalculate the equations of the whole app, of one table, or of one field.Allow Formula RunsFormulas and equations
LogsRead the app's logs: logins, page views, emails, record changes, deleted records, files, imports, API usage and more.Allow LogsLogs API
Backups and restoresStart a backup or a restore. A restore overwrites live data.Allow Backups & RestoresTrigger backups and restores through the API
Webhook subscriptionsSubscribe, list and remove outgoing webhooks.Allow WebhooksThe API Playground's API reference
App schemaRead the whole app's structure in one call (GET schema, full-schema or deep-schema).Allow App SchemaThe API Playground's API reference

Whose access a call has #

A call made with only the API key acts as the app owner, limited by the key's permissions: row-level security does not filter it. A call that also sends an app user's token acts as that user, so row-level security can limit it to what that user may see and change. See Sign in app users through the API.

Plans and rate limits #

Every current plan includes the REST API. Each plan has a limit per minute and per day:

PlanCalls per minuteCalls per day
Business Starter301,000
Business Growth605,000
Business Pro9020,000
Business Elite12050,000

The limits count every call made with your account's keys, across all your apps. Each response carries the remaining limits in its headers; a call over the limit gets a 429 error. See Rate limiting and Error handling.

Was this page helpful?

Something wrong or missing on this page? Tell us.