← Tools Reference

NocoDB

NocoDB integration (Data, Productivity). Imported from open-connector.

API key20 tools{base_url}
GET
nocodb_get_current_user
Get the NocoDB user associated with the connected API token.

/api/v1/auth/user/me

GET
nocodb_list_bases
List bases visible to the connected NocoDB API token.

/api/v2/meta/bases/

GET
nocodb_get_base_schema
Get schema metadata for one NocoDB base.

/api/v2/meta/bases/{baseId}

1 parameter
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
GET
nocodb_list_tables
List tables in a NocoDB base or in a specific base source.

/api/v2/meta/bases/{baseId}/{sourceId}/tables

2 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
sourceIdstringrequiredThe NocoDB source ID.
GET
nocodb_get_table_metadata
Get metadata for one NocoDB table, including columns and views when available.

/api/v2/meta/tables/{tableId}

1 parameter
ParamTypeRequiredDescription
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
DELETE
nocodb_delete_table
Delete a NocoDB table using the v3 metadata API.

/api/v3/meta/bases/{baseId}/tables/{tableId}

2 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
GET
nocodb_list_table_views
List views for a NocoDB table using the v3 metadata API.

/api/v3/meta/bases/{baseId}/tables/{tableId}/views

2 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
POST
nocodb_create_table_view
Create a view for a NocoDB table using the v3 metadata API.

/api/v3/meta/bases/{baseId}/tables/{tableId}/views

3 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
viewobjectrequiredThe NocoDB v3 view creation payload.
POST
nocodb_create_table_field
Create a field in a NocoDB table using the v3 metadata API.

/api/v3/meta/bases/{baseId}/tables/{tableId}/fields

3 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
fieldobjectrequiredThe NocoDB v3 field creation payload.
GET
nocodb_list_records
List records from one NocoDB table with optional where, sort, field, limit, and offset parameters.

/api/v2/tables/{tableId}/records

8 parameters
ParamTypeRequiredDescription
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
limitintegeroptionalThe maximum number of records to return.
offsetintegeroptionalThe zero-based offset for pagination.
wherestringoptionalA NocoDB where expression, such as (Status,eq,Done).
sortstringoptionalA comma-separated sort expression. Prefix a field with - for descending sort.
fieldsstringoptionalA comma-separated list of fields to include.
viewIdstringoptionalThe NocoDB view ID used to restrict records to a specific view.
shufflebooleanoptionalWhether to shuffle the returned records.
GET
nocodb_count_records
Count records in one NocoDB table, optionally filtered by a where expression.

/api/v2/tables/{tableId}/records/count

3 parameters
ParamTypeRequiredDescription
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
wherestringoptionalA NocoDB where expression, such as (Status,eq,Done).
viewIdstringoptionalThe NocoDB view ID used to restrict records to a specific view.
GET
nocodb_read_record
Read one record from a NocoDB table by record ID.

/api/v2/tables/{tableId}/records/{recordId}

3 parameters
ParamTypeRequiredDescription
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
recordIdstringrequiredThe NocoDB record ID value.
fieldsstringoptionalA comma-separated list of fields to include.
DELETE
nocodb_delete_records
Delete one or more records from a NocoDB table.

/api/v2/tables/{tableId}/records

2 parameters
ParamTypeRequiredDescription
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
rowsarrayrequiredRecords to delete. Each record must include its NocoDB record ID.
GET
nocodb_list_table_records
List records from one NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/records

10 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
pageintegeroptionalThe one-based page number to retrieve.
nestedPageintegeroptionalThe one-based page number for nested linked record data.
pageSizeintegeroptionalThe maximum number of records to return.
wherestringoptionalA NocoDB v3 where expression, such as (Status,eq,Done).
sortstringoptionalA NocoDB v3 sort expression.
fieldsstringoptionalA comma-separated list or JSON array string of fields to include.
viewIdstringoptionalThe NocoDB view ID used to restrict records to a specific view.
linksAsLtarbooleanoptionalWhether Links fields should return full linked record data.
GET
nocodb_count_table_records
Count records in one NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/count

4 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
wherestringoptionalA NocoDB v3 where expression, such as (Status,eq,Done).
viewIdstringoptionalThe NocoDB view ID used to restrict records to a specific view.
GET
nocodb_read_table_record
Read one record from a NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/records

5 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
recordIdstringrequiredThe NocoDB record ID value.
fieldsstringoptionalA comma-separated list or JSON array string of fields to include.
linksAsLtarbooleanoptionalWhether Links fields should return full linked record data.
POST
nocodb_create_table_records
Create one or more records in a NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/{suffix}

4 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
recordsarrayrequiredRecords to create in the table.
suffixstringrequiredPath parameter: suffix
PATCH
nocodb_update_table_records
Update one or more records in a NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/{suffix}

4 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
recordsarrayrequiredRecords to update in the table.
suffixstringrequiredPath parameter: suffix
DELETE
nocodb_delete_table_records
Delete one or more records from a NocoDB table using the v3 data API.

/api/v3/data/{baseId}/{tableId}/{suffix}

4 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
recordsarrayrequiredRecords to delete from the table.
suffixstringrequiredPath parameter: suffix
POST
nocodb_upsert_table_records
Create or update records in a NocoDB table by matching up to three fields using the v3 data API.

/api/v3/data/{baseId}/{tableId}/records

4 parameters
ParamTypeRequiredDescription
baseIdstringrequiredThe NocoDB base ID.
tableIdstringrequiredThe NocoDB table ID, such as m1abcdefghijk.
fieldsToMergeOnarrayrequiredField titles or IDs used to match existing records.
recordsarrayrequiredRecords to create or update.