Make your first API request

List your app's tables and then the records of one table with the REST API, in curl and JavaScript, and read the response.

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

On this page
  1. Before you start
  2. 1. List your tables
  3. 2. Read records from a table
  4. 3. Read the response
  5. If it fails
  6. Next steps

This walk-through lists the tables in your app, then reads records from one of them. It takes a few minutes and needs an API key with Allow Reads on.

Before you start #

Create a key with Allow Reads on and copy its App ID, API Key and API Secret (see Create and manage API keys). The examples read them from environment variables:

Shell
export TADABASE_APP_ID="your app ID"
export TADABASE_APP_KEY="your API key"
export TADABASE_APP_SECRET="your API secret"

1. List your tables #

Shell
curl https://api.tadabase.io/api/v1/data-tables \
  -H "X-Tadabase-App-id: $TADABASE_APP_ID" \
  -H "X-Tadabase-App-Key: $TADABASE_APP_KEY" \
  -H "X-Tadabase-App-Secret: $TADABASE_APP_SECRET"

The response lists each table with its ID and name:

JSON
{
  "type": "success",
  "data_tables": [
    { "id": "o6WQb5NnBZ", "name": "Customers" },
    { "id": "4MXQJdrZ6v", "name": "Jobs" }
  ],
  "total_items": 2
}

Copy the id of the table you want to read. To see its fields and their slugs (such as field_36), call GET /api/v1/data-tables/{tableId}/fields; see Tables and fields API.

2. Read records from a table #

Put the table ID in the URL. limit sets how many records come back per page, up to 100:

Shell
curl "https://api.tadabase.io/api/v1/data-tables/4MXQJdrZ6v/records?limit=10" \
  -H "X-Tadabase-App-id: $TADABASE_APP_ID" \
  -H "X-Tadabase-App-Key: $TADABASE_APP_KEY" \
  -H "X-Tadabase-App-Secret: $TADABASE_APP_SECRET"

The same request in JavaScript, run on your server (Node.js 18 or later):

javascript
const res = await fetch('https://api.tadabase.io/api/v1/data-tables/4MXQJdrZ6v/records?limit=10', {
  headers: {
    'X-Tadabase-App-id': process.env.TADABASE_APP_ID,
    'X-Tadabase-App-Key': process.env.TADABASE_APP_KEY,
    'X-Tadabase-App-Secret': process.env.TADABASE_APP_SECRET,
  },
});
const data = await res.json();
if (data.type !== 'success') throw new Error(data.msg);
console.log(data.total_items, 'records;', data.items);

3. Read the response #

JSON
{
  "type": "success",
  "items": [
    {
      "id": "DVWQWRNZ49",
      "field_36": "Replace boiler valve",
      "field_37": "Open",
      "field_41": ["o6WQb5NnBZ"],
      "field_41_val": [{ "id": "o6WQb5NnBZ", "val": "Harbor Bakery" }]
    }
  ],
  "total_items": 42,
  "total_pages": 5,
  "current_page": 1,
  "limit": 10
}
KeyWhat it holds
itemsThe records on this page. Each has its id and one key per field, named by the field's slug.
total_itemsHow many records match, on all pages.
total_pagesHow many pages there are at this limit.
current_pageThe page you got. Ask for another with page=2, page=3 and so on.
limitRecords per page.

A connection field comes back twice: under its slug with the connected record IDs, and with _val added with the IDs and their display values. How every other field type looks is in the Field types reference.

The response headers carry your remaining rate limit: X-RateLimit-Remaining for this minute and X-RateLimit-Daily-Remaining for today. See Rate limiting.

If it fails #

A refused call returns "type": "error" with a msg that says why. The most common first-call errors:

  • 401 "The credentials supplied are missing or invalid.": a header is missing or empty.
  • 403 "The API was not found.": the key or secret is wrong.
  • 412 "The method being used is disabled for this API key.": turn on Allow Reads for the key.

The full list is in Create and manage API keys and Error handling.

Next steps #

Was this page helpful?

Something wrong or missing on this page? Tell us.