NocoDB API Quickstart
The NocoDB REST APIs let you read and write records, manage projects, tables, fields and views, and upload files from your own code. This page takes you from an API token to your first response.
Make your first request
Create an API token
Create a token in Account Settings > Tokens. See API Tokens Management.
Find the base ID and the table ID
The base ID starts with p and the table ID starts with m. Both show in the URL when you open a table. See Find IDs.
List the records of the table
Send the token in the xc-token header.
curl -H "xc-token: <your-token>" \
"https://app.nocodb.com/api/v3/data/<baseId>/<tableId>/records"curl -H "xc-token: <your-token>" \
"http://localhost:8080/api/v3/data/<baseId>/<tableId>/records"Replace http://localhost:8080 with the address of your NocoDB instance.
The response lists the records of the table. Each record has an id, and its field values are in fields. When more records are available, next holds the URL of the next page.
{
"records": [
{
"id": 1,
"fields": {
"SingleLineText": "record #1",
"Number": 1234
}
}
],
"next": "https://app.nocodb.com/api/v3/data/baseId/tableId/records?page=2"
}To get the next pages, see Pagination.
Base URL
| Deployment | Base URL |
|---|---|
| NocoDB Cloud | https://app.nocodb.com |
| Self-hosted | The address of your instance, for example http://localhost:8080 |
What you can build
Use the NocoDB APIs to:
- integrate NocoDB with external applications
- automate workflows
- build custom tools
- manage your projects at scale
To let an LLM client work with NocoDB, use MCP Server or NocoDB Skills instead.
API versions
The where clause of the v3 APIs is slightly different from the where clause of the earlier version. Refer to v3 Where Clause.
Availability
- Collaboration Meta APIs are available on NocoDB Cloud (Business plan and above) and on licensed self-hosted deployments (Business plan and above).
- View and Script Meta APIs are available on NocoDB Cloud (Enterprise plan) and on licensed self-hosted deployments (Business plan and above).
Related
Last updated on