Skip to main content
External databases hold tables and records that you define through the API. You can create a database with its tables and first records, list and read databases and table columns, insert and update records, and search a table. This area has 7 endpoints, and all seven SDKs call every one.
An external database cannot be deleted through the API. Every database you create stays; to put its tables back to a known state, create it again with replace set to true.

At a glance

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

  • Creating a database sends it under external_database. The body has a name and a tables array; each table has table_name, fields and records.
  • Record writes and searches take the table at the top level. Insert, update and search send table_name directly in the body with no wrapper key, and their responses come back under external_database.
  • Each record is a list of field and value pairs. A record looks like {"record": [{"field": "company", "value": "Acme Pty Ltd"}]}.
  • Search results are grouped by table. list holds one array per table name, each row maps column names to values, and count gives the number of rows.
  • Listings page with has_next, has_prev and per_page. This differs from the cursor shape most other listings use; the entries are under data.
  • An unknown database name returns 404.