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
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 #
| Version | Base URL | How the app is named |
|---|---|---|
| v1 | https://api.tadabase.io/ | In the X-Tadabase-App-id header |
| v1.1 | https://api.tadabase.io/ | 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."
| Area | What you can do | Key permission | Read more |
|---|---|---|---|
| Key check | Check that a key works and see its permissions and remaining limits (GET status). | None | Create and manage API keys |
| Tables, fields and roles | List tables, a table's fields with their slugs and types, full field settings, and user roles. | Allow Reads | Tables and fields API |
| Records | List, get, create, update and delete records. | Allow Reads, Allow Updates, Allow Delete | Working with records |
| Filtering | Find records that match conditions, including nested groups. | Allow Reads | Filtering records |
| Sorting and pages | Sort results and page through them, at most 100 records per page. | Allow Reads | Sorting and pagination |
| Field values | How 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 Link | Sign 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 Page | Pages and components API |
| Layouts (v1.1) | List the app's layouts. | Allow Layouts | Pages 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 Export | Imports and exports API |
| PDFs (v1.1) | Create a PDF from a PDF page or a PDF form. | Allow PDF Page, Allow PDF Form | PDF generation API |
| Workflows | List workflows, run one (optionally for one record), check its status and history, and stop a run. | Allow Workflows | Run workflows through the API |
| Tasks | List tasks, run one, check its status and history, and stop it. | Allow Tasks | Run workflows through the API |
| Equations | Recalculate the equations of the whole app, of one table, or of one field. | Allow Formula Runs | Formulas and equations |
| Logs | Read the app's logs: logins, page views, emails, record changes, deleted records, files, imports, API usage and more. | Allow Logs | Logs API |
| Backups and restores | Start a backup or a restore. A restore overwrites live data. | Allow Backups & Restores | Trigger backups and restores through the API |
| Webhook subscriptions | Subscribe, list and remove outgoing webhooks. | Allow Webhooks | The API Playground's API reference |
| App schema | Read the whole app's structure in one call (GET schema, full-schema or deep-schema). | Allow App Schema | The 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:
| Plan | Calls per minute | Calls per day |
|---|---|---|
| Business Starter | 30 | 1,000 |
| Business Growth | 60 | 5,000 |
| Business Pro | 90 | 20,000 |
| Business Elite | 120 | 50,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.