This is the reference for the public No-code Table API. Use the sidebar to explore the API and learn about important concepts.
The No-code Table API can be used to integrate your data in No-code Table with any external system. The API closely follows REST semantics, uses JSON to encode objects, and relies on standard HTTP codes to signal operation outcomes.
Get documents
Returns the list of documents the API key can access in the order they appear on the user's home screen, 1000 bases at a time. If there is another page to request, pass the offset as a URL query parameter.
Authorizations:
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
| cursor | string Base64 cursor for pagination |
| order | string Enum: "touched" "name" |
| direction | string Enum: "ASC" "DESC" order direction |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "documents": [
- {
- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}
], - "cursor": "VEsxMUdzRlNSN3VEU0E3Wk5GQ2I2WHE2ZDVkclVCNlI3bg=="
}Create document
Creates a new document with the provided tables and returns the schema for the newly created base.
Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.
At least one table and field must be specified. The first field in the fields array will be used as the table's primary field and must be a supported primary field type. Fields must have case-insensitive unique names within the table.
Authorizations:
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
New document configuration
| name | string The name for the new document. |
required | Array of objects (TableData) A list of JSON objects representing the tables that will be created along with the base. |
Responses
Request samples
- Payload
{- "name": "Blog",
- "tables": [
- {
- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}
]
}Response samples
- 200
- 400
- 401
- 500
{- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}Get document
Get document by name.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}Update document
Updates the name of the document.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
| schema required | string |
| name required | string |
| color required | string |
| touched required | string |
Responses
Request samples
- Payload
{- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}Delete document
Delete document and all tables.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "documents": [
- {
- "schema": "string",
- "name": "string",
- "color": "string",
- "touched": "string"
}
], - "cursor": "VEsxMUdzRlNSN3VEU0E3Wk5GQ2I2WHE2ZDVkclVCNlI3bg=="
}Get document tables
Returns the schema of the tables in the specified document.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "tables": [
- {
- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}
]
}Create table
Creates a new table and returns the schema for the newly created table.
Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
New table configuration
| name required | string The name for table. |
required | Array of objects (FieldData) Fields configuration |
Responses
Request samples
- Payload
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "tables": [
- {
- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}
]
}Get table
Returns the schema of the table.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}Update table
Updates the name and/or description of a table. At least one of name or description must be specified.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
| name required | string The name for table. |
Responses
Request samples
- Payload
{- "name": "Posts"
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "tables": [
- {
- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}
]
}Delete table
Delete single table.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "tables": [
- {
- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}
]
}Get records total
Retrieve a records total number in the table.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
| filterByFormula | string base64 encoded filter set |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "total": null
}Create field
Creates a new column and returns the schema for the newly created column.
Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
| name required | string The name for table field. |
| type required | string The type for table field in interface. |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}Update field
Updates the name and/or description of a field. At least one of name or description must be specified.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| fieldId required | string Example: Content Column name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
New table configuration
| name required | string The name for table field. |
| type required | string The type for table field in interface. |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}Delete field
Delete Field for from table.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| fieldId required | string Example: Content Column name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}Get table config
Retrieve a table config.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| configId | string Enum: "column-size" "row-size" "row-order" "row-filter" config key |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "value": "string"
}Upload table config
Upload a table config.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| configId | string Enum: "column-size" "row-size" "row-order" "row-filter" config key |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
| value required | string |
Responses
Request samples
- Payload
{- "value": "string"
}Response samples
- 400
- 401
- 404
- 500
{- "error": "string"
}List records
List records in a table. Note that table names and table ids can be used interchangeably. We recommend using table IDs so you don't need to modify your API request when your table name changes.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
| cursor | string Base64 cursor for pagination |
| offset | int |
| limit | int |
| sort | string field id |
| direction | string Enum: "ASC" "DESC" order direction |
| filterByFormula | string base64 encoded filter set |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "records": [
- {
- "id": "string",
- "createdTime": "string",
- "fields": { }
}
], - "cursor": "VEsxMUdzRlNSN3VEU0E3Wk5GQ2I2WHE2ZDVkclVCNlI3bg=="
}Create records
Creates multiple records.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
| records required | Array of objects |
Responses
Request samples
- Payload
{- "records": [
- { }
]
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "records": [
- {
- "id": "string",
- "createdTime": "string",
- "fields": { }
}
], - "cursor": "VEsxMUdzRlNSN3VEU0E3Wk5GQ2I2WHE2ZDVkclVCNlI3bg=="
}Get record
Retrieve a single record.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| recordId required | string Record name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "id": "string",
- "createdTime": "string",
- "fields": { }
}Update record cell
Updates a single record. A PATCH request will only update the fields you specify, leaving the rest as they were.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| recordId required | string Record name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 404
- 500
{- "id": "string",
- "createdTime": "string",
- "fields": { }
}Update record cells
Updates a single record. A PUT request will perform a destructive update and clear all unspecified cell values.
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| recordId required | string Record name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Request Body schema: application/json
Responses
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 404
- 500
{- "id": "string",
- "createdTime": "string",
- "fields": { }
}Delete record
Deletes a single record
Authorizations:
path Parameters
| documentId required | string Example: Blog Project name or identifier |
| tableId required | string Example: Content Table name or identifier |
| recordId required | string Record name or identifier |
query Parameters
| workspaceId | string Example: workspaceId=2 Workspace Id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "name": "Posts",
- "fields": [
- {
- "name": "string",
- "type": "string"
}
]
}