Database API documentation
In this section, we will learn how to connect Baserow with other software.
Baserow makes authentication easy and secure for seamless integration with third-party applications. We are API-first which means it can be integrated with every tool you need to build apps, automate processes and drive productivity.
Overview
REST APIs are core operational tools that enable organizations and developers to consume and build on top of Baserow’s various database capabilities. Baserow API follows REST semantics, uses JSON to encode objects, and relies on standard HTTP codes, and machine and human-readable errors to signal operation outcomes.
The rules and functions to follow in order to make an API call are laid out in the database documentation. Understanding this will help us efficiently manage data retrieval and manipulations through the API.
Baserow API consists of different endpoints for specific actions:
- List fields
GET/api/database/fields/table/{table_id}/ - List rows
GET/api/database/rows/table/{table_id}/ - Get row
GET/api/database/rows/table/{table_id}/{row_id}/ - Create row
POST/api/database/rows/table/{table_id}/ - Update row
PATCH/api/database/rows/table/{table_id}/{row_id}/ - Move row
PATCH/api/database/rows/table/{table_id}/{row_id}/move/ - Delete row
DELETE/api/database/rows/table/{table_id}/{row_id}/
View API docs
After you have created your database schema and API key in the settings, your Baserow database provides its own REST API endpoints to create, read, update, and delete rows. The database documentation is generated automatically based on the tables and fields that are in your database.
To access the database API documentation,
- Click on the vertical ellipsis
⋮beside the selected database. - Select View API Docs from the menu.
If you make changes to your database, table, or fields it could be that the API interface has also changed. Therefore, ensure that you update your API implementation accordingly.
You can create and update rows with link row, single select, and multiple select values by providing the values of the target rows’ primary field e.g.
["name of row 1", "name of row 2", "name of row 3", "name of row 4"]or by providing the internal numerical IDs e.g.[1,2,3,4].
Token-based authentication
In order to use most of the endpoints you need an authorization token and in order to get one you need an account.
Baserow uses a simple token-based authentication. You need to generate at least one database token in your settings to use the endpoints. It is possible to give create, read, update, and delete permissions up until table level per token.
Authenticate to the API by providing your database token in the HTTP authorization bearer token header. All API requests must be authenticated and made over HTTPS.
OpenAPI spec
There is a full specification of the API available here https://api.baserow.io/api/redoc/. You will find documentation and some examples for each endpoint. The OpenAPI spec can also be downloaded in JSON format here https://api.baserow.io/api/schema.json.
View our OpenAPI specification.
Related content
Still need help? If you’re looking for something else, please feel free to make recommendations or ask us questions—we’re ready to assist you.
Contact support for questions about Baserow or help with your account.