NocoDB
NocoDB is an open-source platform that transforms databases into smart spreadsheets, enabling users to manage and collaborate on data with a no-code interface.
Categories: File Storage
Type: nocoDb/v1
Connections
Version: 1
custom
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| baseUrl | NocoDB Base URL | STRING | true | |
| api_token | API Token | STRING | true |
Connection Setup
Connect NocoDB to ByteChef using an API Token.
- Log in to your NocoDB account (Cloud: https://app.nocodb.com).
- Click your avatar in the bottom‑left corner.
- Open API Tokens.
- Click Create new token.
- Enter a descriptive name (for example,
ByteChef Integration) and click Save. - Copy the generated token and keep it secure.
Actions
Create Records
Name: createRecords
Creates a new records in the specified table.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| workspaceId | Workspace ID | STRING | ID of the workspace. | false |
| baseId | Base ID | STRING Depends OnworkspaceId | ID of the base. | false |
| tableId | Table ID | STRING Depends OnbaseId, workspaceId | ID of the table. | true |
| tableColumns | DYNAMIC_PROPERTIES Depends OntableId | null |
Example JSON Structure
{
"label" : "Create Records",
"name" : "createRecords",
"parameters" : {
"workspaceId" : "",
"baseId" : "",
"tableId" : "",
"tableColumns" : { }
},
"type" : "nocoDb/v1/createRecords"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| Id | INTEGER | Id of the created record. |
Output Example
[ {
"Id" : 1
} ]Find Workspace ID
To find the Workspace ID, click here.
Find Base ID
To find the Base ID, click here.
Find Table ID
To find the Table ID, click here.
Delete Records
Name: deleteRecords
Deletes existing records in the specified table.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| workspaceId | Workspace ID | STRING | ID of the workspace. | false |
| baseId | Base ID | STRING Depends OnworkspaceId | ID of the base. | false |
| tableId | Table ID | STRING Depends OnbaseId, workspaceId | ID of the table. | true |
| recordId | Records ID | ARRAY Items[INTEGER] | ID of the records to delete. | true |
Example JSON Structure
{
"label" : "Delete Records",
"name" : "deleteRecords",
"parameters" : {
"workspaceId" : "",
"baseId" : "",
"tableId" : "",
"recordId" : [ 1 ]
},
"type" : "nocoDb/v1/deleteRecords"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| Id | INTEGER | Id of the deleted record. |
Output Example
[ {
"Id" : 1
} ]Find Workspace ID
To find the Workspace ID, click here.
Find Base ID
To find the Base ID, click here.
Find Table ID
To find the Table ID, click here.
Find Record ID
To find the Record ID, click here.
Get Record
Name: getRecord
Gets a record from the specified table.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| workspaceId | Workspace ID | STRING | ID of the workspace. | false |
| baseId | Base ID | STRING Depends OnworkspaceId | ID of the base. | false |
| tableId | Table ID | STRING Depends OnbaseId, workspaceId | ID of the table. | true |
| recordId | Record ID | STRING | ID of the record to retrieve. | true |
| fields | Fields | ARRAY Items[STRING] | Fields to include in the response. By default, all the fields are included in the response. | false |
Example JSON Structure
{
"label" : "Get Record",
"name" : "getRecord",
"parameters" : {
"workspaceId" : "",
"baseId" : "",
"tableId" : "",
"recordId" : "",
"fields" : [ "" ]
},
"type" : "nocoDb/v1/getRecord"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Workspace ID
To find the Workspace ID, click here.
Find Base ID
To find the Base ID, click here.
Find Table ID
To find the Table ID, click here.
Find Record ID
To find the Record ID, click here.
Search Records
Name: searchRecords
Searches for records in the specified table.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| workspaceId | Workspace ID | STRING | ID of the workspace. | false |
| baseId | Base ID | STRING Depends OnworkspaceId | ID of the base. | false |
| tableId | Table ID | STRING Depends OnbaseId, workspaceId | ID of the table. | true |
| fields | Fields | ARRAY Items[STRING] | Fields to include in the response. By default, all the fields are included in the response. | false |
| sort | Sort By | ARRAY Items[{STRING(field), STRING(order)}] | Fields by which you want to sort the records in your response. | false |
| where | Where | STRING | Specific conditions for filtering records in your response. Multiple conditions can be combined using logical operators such as 'and' and 'or'. Each condition consists of three parts: a field name, a comparison operator, and a value. | false |
Example JSON Structure
{
"label" : "Search Records",
"name" : "searchRecords",
"parameters" : {
"workspaceId" : "",
"baseId" : "",
"tableId" : "",
"fields" : [ "" ],
"sort" : [ {
"field" : "",
"order" : ""
} ],
"where" : ""
},
"type" : "nocoDb/v1/searchRecords"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Workspace ID
To find the Workspace ID, click here.
Find Base ID
To find the Base ID, click here.
Find Table ID
To find the Table ID, click here.
Update Records
Name: updateRecords
Updates existing records in the specified table.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| workspaceId | Workspace ID | STRING | ID of the workspace. | false |
| baseId | Base ID | STRING Depends OnworkspaceId | ID of the base. | false |
| tableId | Table ID | STRING Depends OnbaseId, workspaceId | ID of the table. | true |
| tableColumns | DYNAMIC_PROPERTIES Depends OntableId | null |
Example JSON Structure
{
"label" : "Update Records",
"name" : "updateRecords",
"parameters" : {
"workspaceId" : "",
"baseId" : "",
"tableId" : "",
"tableColumns" : { }
},
"type" : "nocoDb/v1/updateRecords"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| Id | INTEGER | Id of the updated record. |
Output Example
[ {
"Id" : 1
} ]Find Workspace ID
To find the Workspace ID, click here.
Find Base ID
To find the Base ID, click here.
Find Table ID
To find the Table ID, click here.
Find Record ID
To find the Record ID, click here.
Additional Instructions
How to find Workspace ID
Workspace ID is an alphanumeric identifier prefixed with w (representing workspace) that uniquely identifies your workspace in NocoDB. It appears in the URL bar when viewing any base within the workspace.
You can also find it in the workspace context menu (accessible by clicking the workspace icon in the minibar). Click the ID to copy it to your clipboard.
Workspace ID can also be retrieved from Workspace settings page.
How to find Base ID
The Base ID is an alphanumeric identifier prefixed with p (representing project), visible in the URL when accessing any table or base-level settings. You can also find it in the base context menu (chevron next to the base name) in the left sidebar, where you can click the ID to copy it to your clipboard.
How to find Table ID
The Table ID is an alphanumeric string prefixed with m (representing model), visible in the URL immediately after the Base ID when viewing a table. You can also find it in the table context menu (three dots next to the table name) in the left sidebar. Click the ID to copy it to your clipboard.
How to find Record ID
By default, the Record ID is a numeric value starting from 1. You can display the ID field (which corresponds to the Record ID) by opening the Fields menu in the toolbar and enabling Show System Fields.
You can also find it in the URL when viewing a specific record (expanded record view).
You can also access the Record ID in formulas by selecting ID from the list of available fields in the formula editor or by using the RECORD_ID() function.
How is this guide?
Last updated on