REST APIs

Once you've created the schemas, you can manipulate the data or invoke actions using the REST APIs. We provide several types of APIs for different usages as below.

API Overview

Here's the overview of all APIs. For the details, please check out NocoDB API Documentation.

You may also interact with the API's resources via Swagger UI.

Currently, the default value for {orgs} is noco. Users will be able to change it in the future release.

Auth APIs

CategoryMethodTagFunction NamePath
AuthPostauthsignup/api/v1/auth/user/signup
AuthPostauthsignin/api/v1/auth/user/signin
AuthGetauthme/api/v1/auth/user/me
AuthPostauthpasswordForgot/api/v1/auth/password/forgot
AuthPostauthpasswordChange/api/v1/auth/password/change
AuthPostauthpasswordReset/api/v1/auth/password/reset/{token}
AuthPostauthtokenRefresh/api/v1/auth/token/refresh
AuthPostauthpasswordResetTokenValidate/api/v1/auth/token/validate/{token}
AuthPostauthemailValidate/api/v1/auth/email/validate/{email}

Public APIs

CategoryMethodTagFunction NamePath
PublicGetpublicsharedBaseGet/api/v1/db/public/shared-base/{sharedBaseUuid}/meta
PublicPostpublicdataList/api/v1/db/public/shared-view/{sharedViewUuid}/rows
PublicGetpublicdataNestedList/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}
PublicPostpublicdataCreate/api/v1/db/public/shared-view/{sharedViewUuid}/rows
PublicGetpubliccsvExport/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}
PublicGetpublicdataRelationList/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}
PublicGetpublicsharedViewMetaGet/api/v1/db/public/shared-view/{sharedViewUuid}/meta

Data APIs

CategoryMethodTagFunction NamePath
DataDeletedbTableRowbulkDelete/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPostdbTableRowbulkCreate/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPatchdbTableRowbulkUpdate/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/
DataPatchdbTableRowbulkUpdateAll/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all
DataDeletedbTableRowbulkDeleteAll/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all
DataGetdbTableRowlist/api/v1/db/data/{orgs}/{projectName}/{tableName}
DataGetdbTableRowfindOne/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one
DataGetdbTableRowgroupBy/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby
DataGetdbTableRowexist/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist
DataPostdbTableRowcreate/api/v1/db/data/{orgs}/{projectName}/{tableName}
DataGetdbTableRowread/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataPatchdbTableRowupdate/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataDeletedbTableRowdelete/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}
DataGetdbTableRowcount/api/v1/db/data/{orgs}/{projectName}/{tableName}/count
DataGetdbViewRowlist/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}
DataGetdbViewRowfindOne/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one
DataGetdbViewRowgroupBy/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby
DataGetdbViewRowexist/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist
DataPostdbViewRowcreate/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}
DataGetdbViewRowread/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataPatchdbViewRowupdate/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataDeletedbViewRowdelete/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
DataGetdbViewRowcount/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count

Meta APIs

CategoryMethodTagFunction NamePath
MetaGetapiTokenlist/api/v1/db/meta/projects/{projectId}/api-tokens
MetaPostapiTokencreate/api/v1/db/meta/projects/{projectId}/api-tokens
MetaDeleteapiTokendelete/api/v1/db/meta/projects/{projectId}/api-tokens/{token}
MetaGetauthprojectUserList/api/v1/db/meta/projects/{projectId}/users
MetaPostauthprojectUserAdd/api/v1/db/meta/projects/{projectId}/users
MetaPatchauthprojectUserUpdate/api/v1/db/meta/projects/{projectId}/users/{userId}
MetaDeleteauthprojectUserRemove/api/v1/db/meta/projects/{projectId}/users/{userId}
MetaPostauthprojectUserResendInvite/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite
MetaPostdbTablecreate/api/v1/db/meta/projects/{projectId}/tables
MetaGetdbTablelist/api/v1/db/meta/projects/{projectId}/tables
MetaPostdbTableColumncreate/api/v1/db/meta/tables/{tableId}/columns
MetaPatchdbTableColumnupdate/api/v1/db/meta/tables/{tableId}/columns/{columnId}
MetaDeletedbTableColumndelete/api/v1/db/meta/tables/{tableId}/columns/{columnId}
MetaPostdbTableColumnprimaryColumnSet/api/v1/db/meta/tables/{tableId}/columns/{columnId}/primary
MetaGetdbTableFilterget/api/v1/db/meta/filters/{filterId}
MetaPatchdbTableFilterupdate/api/v1/db/meta/filters/{filterId}
MetaDeletedbTableFilterdelete/api/v1/db/meta/filters/{filterId}
MetaGetdbTableFilterread/api/v1/db/meta/views/{viewId}/filters
MetaPostdbTableFiltercreate/api/v1/db/meta/views/{viewId}/filters
MetaGetdbTableFilterget/api/v1/db/meta/filters/{filterId}
MetaPatchdbTableFilterupdate/api/v1/db/meta/filters/{filterId}
MetaDeletedbTableFilterdelete/api/v1/db/meta/filters/{filterId}
MetaGetdbTableFilterchildrenRead/api/v1/db/meta/filters/{filterGroupId}/children
MetaGetdbTableSortlist/api/v1/db/meta/views/{viewId}/sorts
MetaPostdbTableSortcreate/api/v1/db/meta/views/{viewId}/sorts
MetaGetdbTableSortread/api/v1/db/meta/sorts/{sortId}
MetaPatchdbTableSortupdate/api/v1/db/meta/sorts/{sortId}
MetaDeletedbTableSortdelete/api/v1/db/meta/sorts/{sortId}/api/v1/db
MetaPatchdbTableWebhookupdate/api/v1/db/meta/hooks/{hookId}
MetaDeletedbTableWebhookdelete/api/v1/db/meta/hooks/{hookId}
MetaGetdbTableWebhooklist/api/v1/db/meta/tables/{tableId}/hooks
MetaPostdbTableWebhookcreate/api/v1/db/meta/tables/{tableId}/hooks
MetaPostdbTableWebhooktest/api/v1/db/meta/tables/{tableId}/hooks/test
MetaGetdbTableWebhooksamplePayloadGet/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}
MetaGetdbTableWebhookFilterread/api/v1/db/meta/hooks/{hookId}/filters
MetaPostdbTableWebhookFiltercreate/api/v1/db/meta/hooks/{hookId}/filters
MetaGetdbViewlist/api/v1/db/meta/tables/{tableId}/views
MetaGetdbViewread/api/v1/db/meta/tables/{tableId}
MetaPatchdbViewupdate/api/v1/db/meta/tables/{tableId}
MetaDeletedbViewdelete/api/v1/db/meta/tables/{tableId}
MetaPostdbViewreorder/api/v1/db/meta/tables/{tableId}/reorder
MetaPostdbViewformCreate/api/v1/db/meta/forms
MetaPatchdbViewformUpdate/api/v1/db/meta/forms/{formId}
MetaGetdbViewformRead/api/v1/db/meta/forms/{formId}
MetaPatchdbViewformColumnUpdate/api/v1/db/meta/form-columns/{formViewColumnId}
MetaPostdbViewgalleryCreate/api/v1/db/meta/galleries
MetaPatchdbViewgalleryUpdate/api/v1/db/meta/galleries/{galleriesId}
MetaGetdbViewgalleryRead/api/v1/db/meta/galleries/{galleriesId}
MetaPostdbViewgridCreate/api/v1/db/meta/tables/${tableId}/grids
MetaGetdbViewgridColumnsList/api/v1/db/meta/grids/{gridId}/grid-columns
MetaPatchdbViewgridColumnUpdate/api/v1/db/meta/grid-columns/{columnId}
MetaPatchdbViewupdate/api/v1/db/meta/views/{viewId}
MetaDeletedbViewdelete/api/v1/db/meta/views/{viewId}
MetaPostdbViewshowAllColumn/api/v1/db/meta/views/{viewId}/show-all
MetaPostdbViewhideAllColumn/api/v1/db/meta/views/{viewId}/hide-all
MetaGetdbViewColumnlist/api/v1/db/meta/views/{viewId}/columns
MetaPostdbViewColumncreate/api/v1/db/meta/views/{viewId}/columns
MetaPatchdbViewColumnupdate/api/v1/db/meta/views/{viewId}/columns/{columnId}
MetaGetdbViewSharelist/api/v1/db/meta/views/{viewId}/share
MetaPostdbViewSharecreate/api/v1/db/meta/views/{viewId}/share
MetaPatchdbViewShareupdate/api/v1/db/meta/views/{viewId}/share
MetaDeletedbViewSharedelete/api/v1/db/meta/views/{viewId}/share
MetaGetpluginlist/api/v1/db/meta/plugins
MetaGetpluginstatus/api/v1/db/meta/plugins/{pluginTitle}/status
MetaPostplugintest/api/v1/db/meta/plugins/test
MetaPATCHpluginupdate/api/v1/db/meta/plugins/{pluginId}
MetaGetpluginread/api/v1/db/meta/plugins/{pluginId}
MetaGetprojectmetaGet/api/v1/db/meta/projects/{projectId}/info
MetaGetprojectmodelVisibilityList/api/v1/db/meta/projects/{projectId}/visibility-rules
MetaPostprojectmodelVisibilitySet/api/v1/db/meta/projects/{projectId}/visibility-rules
MetaGetprojectlist/api/v1/db/meta/projects
MetaPostprojectcreate/api/v1/db/meta/projects
MetaGetprojectread/api/v1/db/meta/projects/{projectId}
MetaDeleteprojectdelete/api/v1/db/meta/projects/{projectId}
MetaGetprojectauditList/api/v1/db/meta/projects/{projectId}/audits
MetaGetprojectmetaDiffGet/api/v1/db/meta/projects/{projectId}/meta-diff
MetaPostprojectmetaDiffSync/api/v1/db/meta/projects/{projectId}/meta-diff
MetaGetprojectsharedBaseGet/api/v1/db/meta/projects/{projectId}/shared
MetaDeleteprojectsharedBaseDisable/api/v1/db/meta/projects/{projectId}/shared
MetaPostprojectsharedBaseCreate/api/v1/db/meta/projects/{projectId}/shared
MetaPatchprojectsharedBaseUpdate/api/v1/db/meta/projects/{projectId}/shared
MetaPoststorageupload/api/v1/db/storage/upload
MetaPoststorageuploadByUrl/api/v1/db/storage/upload-by-url
MetaGetutilscommentList/api/v1/db/meta/audits/comments
MetaPostutilscommentRow/api/v1/db/meta/audits/comments
MetaGetutilscommentCount/api/v1/db/meta/audits/comments/count
MetaPostutilsauditRowUpdate/api/v1/db/meta/audits/update
MetaGetutilscacheGet/api/v1/db/meta/cache
MetaDeleteutilscacheDelete/api/v1/db/meta/cache
MetaPostutilstestConnection/api/v1/db/meta/projects/connection/test
MetaGetutilsappInfo/api/v1/db/meta/nocodb/info
MetaGetutilsappVersion/api/v1/version
MetaGetutilsappHealth/api/v1/health

Query params

NameAliasUse caseDefault valueExample value
wherewComplicated where conditions(colName,eq,colValue)~or(colName2,gt,colValue2)
Usage: Comparison operators
Usage: Logical operators
limitlNumber of rows to get (SQL limit value)1020
offsetoOffset for pagination (SQL offset value)020
sortsSort by column name, Use - as prefix for descending sortcolumn_name
fieldsfRequired column names in result*column_name1,column_name2
shufflerShuffle the result for pagination01 (Only allow 0 or 1. Other values would see it as 0)

Comparison Operators

OperationMeaningExample
eqequal(colName,eq,colValue)
neqnot equal(colName,neq,colValue)
notnot equal (alias of neq)(colName,not,colValue)
gtgreater than(colName,gt,colValue)
gegreater or equal(colName,ge,colValue)
ltless than(colName,lt,colValue)
leless or equal(colName,le,colValue)
isis(colName,is,true/false/null)
isnotis not(colName,isnot,true/false/null)
inin(colName,in,val1,val2,val3,val4)
btwbetween(colName,btw,val1,val2)
nbtwnot between(colName,nbtw,val1,val2)
likelike(colName,like,%name)

Logical Operators

OperationExample
~or(checkNumber,eq,JM555205)~or((amount, gt, 200)~and(amount, lt, 2000))
~and(checkNumber,eq,JM555205)~and((amount, gt, 200)~and(amount, lt, 2000))
~not~not(checkNumber,eq,JM555205)