ByteChef LogoByteChef

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

NameLabelTypeDescriptionRequired
baseUrlNocoDB Base URLSTRINGtrue
api_tokenAPI TokenSTRINGtrue

Connection Setup

Connect NocoDB to ByteChef using an API Token.

  1. Log in to your NocoDB account (Cloud: https://app.nocodb.com).
  2. Click your avatar in the bottom‑left corner.
  3. Open API Tokens.
  4. Click Create new token.
  5. Enter a descriptive name (for example, ByteChef Integration) and click Save.
  6. Copy the generated token and keep it secure.

Actions

Create Records

Name: createRecords

Creates a new records in the specified table.

Properties

NameLabelTypeDescriptionRequired
workspaceIdWorkspace IDSTRINGID of the workspace.false
baseIdBase IDSTRING
Depends On workspaceId
ID of the base.false
tableIdTable IDSTRING
Depends On baseId, workspaceId
ID of the table.true
tableColumnsDYNAMIC_PROPERTIES
Depends On tableId
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

NameTypeDescription
IdINTEGERId of the created record.

Output Example

[ {
  "Id" : 1
} ]

Delete Records

Name: deleteRecords

Deletes existing records in the specified table.

Properties

NameLabelTypeDescriptionRequired
workspaceIdWorkspace IDSTRINGID of the workspace.false
baseIdBase IDSTRING
Depends On workspaceId
ID of the base.false
tableIdTable IDSTRING
Depends On baseId, workspaceId
ID of the table.true
recordIdRecords IDARRAY
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

NameTypeDescription
IdINTEGERId of the deleted record.

Output Example

[ {
  "Id" : 1
} ]

Get Record

Name: getRecord

Gets a record from the specified table.

Properties

NameLabelTypeDescriptionRequired
workspaceIdWorkspace IDSTRINGID of the workspace.false
baseIdBase IDSTRING
Depends On workspaceId
ID of the base.false
tableIdTable IDSTRING
Depends On baseId, workspaceId
ID of the table.true
recordIdRecord IDSTRINGID of the record to retrieve.true
fieldsFieldsARRAY
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.

Search Records

Name: searchRecords

Searches for records in the specified table.

Properties

NameLabelTypeDescriptionRequired
workspaceIdWorkspace IDSTRINGID of the workspace.false
baseIdBase IDSTRING
Depends On workspaceId
ID of the base.false
tableIdTable IDSTRING
Depends On baseId, workspaceId
ID of the table.true
fieldsFieldsARRAY
Items [STRING]
Fields to include in the response. By default, all the fields are included in the response.false
sortSort ByARRAY
Items [{STRING(field), STRING(order)}]
Fields by which you want to sort the records in your response.false
whereWhereSTRINGSpecific 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.

Update Records

Name: updateRecords

Updates existing records in the specified table.

Properties

NameLabelTypeDescriptionRequired
workspaceIdWorkspace IDSTRINGID of the workspace.false
baseIdBase IDSTRING
Depends On workspaceId
ID of the base.false
tableIdTable IDSTRING
Depends On baseId, workspaceId
ID of the table.true
tableColumnsDYNAMIC_PROPERTIES
Depends On tableId
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

NameTypeDescription
IdINTEGERId of the updated record.

Output Example

[ {
  "Id" : 1
} ]

How is this guide?

Last updated on

On this page