NocoDB

This API deletes the base identified by its baseId. Deleting a base is a permanent action that removes all its associated data and cannot be undone. Use this API with caution when managing your workspaces. via DELETE /api/v2/meta/bases/{baseId}

Delete the given API Token in base via DELETE /api/v2/meta/bases/{baseId}/api-tokens/{tokenId}

Delete Base Shared Base via DELETE /api/v2/meta/bases/{baseId}/shared

Delete the source details of a given base via DELETE /api/v2/meta/bases/{baseId}/sources/{sourceId}

Delete a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked. via DELETE /api/v2/meta/bases/{baseId}/users/{userId}

Delete All K/V pairs in NocoCache via DELETE /api/v2/meta/cache

Delete the existing column by the given column ID via DELETE /api/v2/meta/columns/{columnId}

Delete comment via DELETE /api/v2/meta/comment/{commentId}

Delete the filter data with a given Filter ID via DELETE /api/v2/meta/filters/{filterId}

Delete the exsiting hook by its ID via DELETE /api/v2/meta/hooks/{hookId}

Delete the sort data by Sort ID via DELETE /api/v2/meta/sorts/{sortId}

Delete table by the given table ID. via DELETE /api/v2/meta/tables/{tableId}

Delete the view with the given view Id. via DELETE /api/v2/meta/views/{viewId}

Delete a shared view in a given View. via DELETE /api/v2/meta/views/{viewId}/share

Delete workspace via DELETE /api/v2/meta/workspaces/{workspaceId}

This API endpoint allows you to unlink records from a specific `Link field` and `Record ID`. The request payload is an array of record-ids from the adjacent table for unlinking purposes. Note that, - duplicated record-ids will be ignored. - non-existent record-ids will be ignored. via DELETE /api/v2/tables/{tableId}/links/{linkFieldId}/records/{recordId}

This API endpoint allows deleting existing records within a specified table identified by an array of Record-IDs, serving as unique identifier for the record. Records to be deleted are input as an array of record-identifiers. via DELETE /api/v2/tables/{tableId}/records

Retrieve a list of all available bases (OSS version). via GET /api/v2/meta/bases

This API fetches detailed information about the base specified by its unique baseId. It provides metadata such as the base's title, description, creation date, color, and configuration settings. via GET /api/v2/meta/bases/{baseId}

List API Tokens in the given base via GET /api/v2/meta/bases/{baseId}/api-tokens

List all tables in a given Base and Source via GET /api/v2/meta/bases/{baseId}/{sourceId}/tables

Check if a base contains empty and null filters. Used in `Show NULL and EMPTY in Filter` in Base Setting. via GET /api/v2/meta/bases/{baseId}/has-empty-or-null-filters

Get info such as node version, arch, platform, is docker, rootdb and package version of a given base via GET /api/v2/meta/bases/{baseId}/info

Get the meta data difference between NC_DB and external data sources via GET /api/v2/meta/bases/{baseId}/meta-diff

Get the meta data difference between NC_DB and external data sources in a given Source via GET /api/v2/meta/bases/{baseId}/meta-diff/{sourceId}

Get Base Shared Base via GET /api/v2/meta/bases/{baseId}/shared

This endpoint allows you to list all (data) sources within a specified base. The API returns a paginated list of data sources.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of sources available in the specified Base ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of source items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of source records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of source records in the dataset. via GET /api/v2/meta/bases/{baseId}/sources

Get the source details of a given base via GET /api/v2/meta/bases/{baseId}/sources/{sourceId}

This endpoint allows you to list all tables within a specified base. The API returns a paginated list of table. **Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block: - `totalRows`: Indicates the total number of tables available in the specified Base ID. - `page`: Specifies the current page number. - `pageSize`: Defaults to 25 and defines the number of table items listed on each page. - `isFirstPage`: A boolean value that indicates whether the current page is the first page of table records in the dataset. - `isLastPage`: A boolean value that indicates whether the current page is the last page of table records in the dataset. via GET /api/v2/meta/bases/{baseId}/tables

This endpoint allows you to list all users (collaborators) within a specified base. The API returns a paginated list of users.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of users available in the specified Base ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of user items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of user records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of user records in the dataset. via GET /api/v2/meta/bases/{baseId}/users

Hide / show views based on user role via GET /api/v2/meta/bases/{baseId}/visibility-rules

Get All K/V pairs in NocoCache via GET /api/v2/meta/cache

Get the existing column by the given column ID via GET /api/v2/meta/columns/{columnId}

List all comments via GET /api/v2/meta/comments

Return the number of comments in the given query. via GET /api/v2/meta/comments/count

Get Filter Group Children of a given group ID via GET /api/v2/meta/filters/{filterGroupId}/children

Get the filter data with a given Filter ID via GET /api/v2/meta/filters/{filterId}

Get the form data by Form ID via GET /api/v2/meta/forms/{formViewId}

Get the Gallery View data with Gallery ID via GET /api/v2/meta/galleries/{galleryViewId}

List all columns in the given Grid via GET /api/v2/meta/grids/{gridId}/grid-columns

Get the filter data in a given Hook via GET /api/v2/meta/hooks/{hookId}/filters

List the log data in a given Hook via GET /api/v2/meta/hooks/{hookId}/logs

Get the Kanban View data by Kanban ID via GET /api/v2/meta/kanbans/{kanbanViewId}

Get the Map View data by Map ID via GET /api/v2/meta/maps/{mapViewId}

Get the application info such as authType, defaultLimit, version and etc. via GET /api/v2/meta/nocodb/info

List all plugins via GET /api/v2/meta/plugins

Get the plugin data by ID via GET /api/v2/meta/plugins/{pluginId}

Check plugin is active or not via GET /api/v2/meta/plugins/{pluginId}/status

List all webhook plugins via GET /api/v2/meta/plugins/webhook

Get the sort data by Sort ID via GET /api/v2/meta/sorts/{sortId}

Get the table meta data by the given table ID via GET /api/v2/meta/tables/{tableId}

Get columns hash for table via GET /api/v2/meta/tables/{tableId}/columns/hash

This endpoint allows you to list all webhooks within a specified table. The API returns a paginated list of webhooks.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of webhooks available in the specified Table ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of webhook items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of webhook records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of webhook records in the dataset. via GET /api/v2/meta/tables/{tableId}/hooks

Get the sample hook payload via GET /api/v2/meta/tables/{tableId}/hooks/samplePayload/{event}/{operation}/{version}

This endpoint allows you to list all Shared Views within a specified table. The API returns a paginated list of shared views.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of shared views available in the specified Table ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of shared view items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of shared view records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of shared view records in the dataset. via GET /api/v2/meta/tables/{tableId}/share

This endpoint allows you to list all views within a specified table. The API returns a paginated list of views. **Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block: - `totalRows`: Indicates the total number of views available in the specified Table ID. - `page`: Specifies the current page number. - `pageSize`: Defaults to 25 and defines the number of view items listed on each page. - `isFirstPage`: A boolean value that indicates whether the current page is the first page of view records in the dataset. - `isLastPage`: A boolean value that indicates whether the current page is the last page of view records in the dataset. via GET /api/v2/meta/tables/{tableId}/views

This endpoint allows you to list all columns within a specified view. The API returns a paginated list of columns. **Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block: - `totalRows`: Indicates the total number of columns available in the specified View ID. - `page`: Specifies the current page number. - `pageSize`: Defaults to 25 and defines the number of column items listed on each page. - `isFirstPage`: A boolean value that indicates whether the current page is the first page of column records in the dataset. - `isLastPage`: A boolean value that indicates whether the current page is the last page of column records in the dataset. via GET /api/v2/meta/views/{viewId}/columns

This endpoint allows you to list all filters within a specified view. The API returns a paginated list of filters.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of filters available in the specified View ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of filter items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of filter records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of filter records in the dataset. via GET /api/v2/meta/views/{viewId}/filters

This endpoint allows you to list all sorts within a specified view. The API returns a paginated list of sorts.\n\n**Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block:\n\n- `totalRows`: Indicates the total number of sorts available in the specified View ID.\n- `page`: Specifies the current page number.\n- `pageSize`: Defaults to 25 and defines the number of sort items listed on each page.\n- `isFirstPage`: A boolean value that indicates whether the current page is the first page of sort records in the dataset.\n- `isLastPage`: A boolean value that indicates whether the current page is the last page of sort records in the dataset. via GET /api/v2/meta/views/{viewId}/sorts

List workspaces via GET /api/v2/meta/workspaces

Read workspace via GET /api/v2/meta/workspaces/{workspaceId}

This API fetches list of bases associated with the specified workspace ID. The workspace ID must be provided in the path as a required parameter. The API returns a list in JSON format, containing metadata and configuration for each base. The API returns a paginated list of bases. **Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block: - `totalRows`: Indicates the total number of bases available in the specified Workspace ID. - `page`: Specifies the current page number. - `pageSize`: Defaults to 25 and defines the number of base items listed on each page. - `isFirstPage`: A boolean value that indicates whether the current page is the first page of base records in the dataset. - `isLastPage`: A boolean value that indicates whether the current page is the last page of base records in the dataset. via GET /api/v2/meta/workspaces/{workspaceId}/bases

List all shared view rows via GET /api/v2/public/calendar-view/{sharedViewUuid}

Count of Records in Dates in Calendar View via GET /api/v2/public/calendar-view/{sharedViewUuid}/countByDate

Get Share Source Meta via GET /api/v2/public/shared-base/{sharedBaseUuid}/meta

Read aggregated data from a given table via GET /api/v2/public/shared-view/{sharedViewUuid}/aggregate

List Shared View Grouped Data via GET /api/v2/public/shared-view/{sharedViewUuid}/group/{columnId}

List all shared view rows grouped by a column via GET /api/v2/public/shared-view/{sharedViewUuid}/groupby

Get Share View Meta via GET /api/v2/public/shared-view/{sharedViewUuid}/meta

List Nested Data Relation via GET /api/v2/public/shared-view/{sharedViewUuid}/nested/{columnName}

List all shared view rows via GET /api/v2/public/shared-view/{sharedViewUuid}/rows

List all nested list data in a given shared view via GET /api/v2/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}

This API endpoint allows you to retrieve list of linked records for a specific `Link field` and `Record ID`. The response is an array of objects containing Primary Key and its corresponding display value. via GET /api/v2/tables/{tableId}/links/{linkFieldId}/records/{recordId}

This API endpoint allows you to retrieve records from a specified table. You can customize the response by applying various query parameters for filtering, sorting, and formatting. **Pagination**: The response is paginated by default, with the first page being returned initially. The response includes the following additional information in the `pageInfo` JSON block: - `totalRows`: Indicates the total number of rows available for the specified conditions (if any). - `page`: Specifies the current page number. - `pageSize`: Defaults to 25 and defines the number of records on each page. - `isFirstPage`: A boolean value that indicates whether the current page is the first page of records in the dataset. - `isLastPage`: A boolean value that indicates whether the current page is the last page of records in the dataset. The `pageInfo` attributes are particularly valuable when dealing with large datasets that are divided into multiple pages. They enable you to determine whether additional pages of records are available for retrieval or if you've reached the end of the dataset. via GET /api/v2/tables/{tableId}/records

This API endpoint allows you to retrieve a single record identified by Record-ID, serving as unique identifier for the record from a specified table. via GET /api/v2/tables/{tableId}/records/{recordId}

This API endpoint allows you to retrieve the total number of records from a specified table or a view. You can narrow down search results by applying `where` query parameter via GET /api/v2/tables/{tableId}/records/count

This API updates the properties of a specified base, such as its title, color, order, or metadata. The baseId is required to identify the base to be updated. via PATCH /api/v2/meta/bases/{baseId}

Update Base Shared Base via PATCH /api/v2/meta/bases/{baseId}/shared

Update the source details of a given base via PATCH /api/v2/meta/bases/{baseId}/sources/{sourceId}

Base user meta update via PATCH /api/v2/meta/bases/{baseId}/user

Update a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked. via PATCH /api/v2/meta/bases/{baseId}/users/{userId}

Update the existing column by the given column ID via PATCH /api/v2/meta/columns/{columnId}

Update comment via PATCH /api/v2/meta/comment/{commentId}

Update the filter data with a given Filter ID via PATCH /api/v2/meta/filters/{filterId}

Update the form column(s) by Form View Column ID via PATCH /api/v2/meta/form-columns/{formViewColumnId}

Update the form data by Form ID via PATCH /api/v2/meta/forms/{formViewId}

Update the Gallery View data with Gallery ID via PATCH /api/v2/meta/galleries/{galleryViewId}

Update grid column(s) in the given Grid via PATCH /api/v2/meta/grid-columns/{columnId}

Update Grid View via PATCH /api/v2/meta/grids/{viewId}

Update the exsiting hook by its ID via PATCH /api/v2/meta/hooks/{hookId}

Update the Kanban View data with Kanban ID via PATCH /api/v2/meta/kanbans/{kanbanViewId}

Update the Map View data by Map ID via PATCH /api/v2/meta/maps/{mapViewId}

Update the plugin data by ID via PATCH /api/v2/meta/plugins/{pluginId}

Update the sort data by Sort ID via PATCH /api/v2/meta/sorts/{sortId}

Update the table meta data by the given table ID via PATCH /api/v2/meta/tables/{tableId}

Update User Profile via PATCH /api/v2/meta/user/profile

Update the view with the given view Id. via PATCH /api/v2/meta/views/{viewId}

Update a column in a View via PATCH /api/v2/meta/views/{viewId}/columns/{columnId}

Update a shared view in a given View.. via PATCH /api/v2/meta/views/{viewId}/share

Update workspace via PATCH /api/v2/meta/workspaces/{workspaceId}

This API endpoint allows updating existing records within a specified table identified by an array of Record-IDs, serving as unique identifier for the record. Records to be updated are input as an array of key-value pair objects, where each key corresponds to a field name. Ensure that all the required fields are included in the payload, with exceptions for fields designated as auto-increment or those having default values. When dealing with 'Links' or 'Link To Another Record' field types, you should utilize the 'Create Link' API to insert relevant data. Certain read-only field types will be disregarded if included in the request. These field types include 'Look Up,' 'Roll Up,' 'Formula,' 'Auto Number,' 'Created By,' 'Updated By,' 'Created At,' 'Updated At,' 'Barcode,' and 'QR Code.' Note that a PATCH request only updates the specified fields while leaving other fields unaffected. Currently, PUT requests are not supported by this endpoint. via PATCH /api/v2/tables/{tableId}/records

Api for verifying email where token need to be passed which is shared to user email. via POST /api/v2/auth/email/validate/{token}

Emails user with a reset url. via POST /api/v2/auth/password/forgot

Validate password reset url token. via POST /api/v2/auth/token/validate/{token}

Clear refresh token from the database and cookie. via POST /api/v2/auth/user/signout

Trigger export as job via POST /api/v2/export/{viewId}/{exportAs}

Get list of jobs for a given base for the user via POST /api/v2/jobs/{baseId}

Create a new base in the system (OSS version). via POST /api/v2/meta/bases

Create a new table in a given Base and Source via POST /api/v2/meta/bases/{baseId}/{sourceId}/tables

Synchronise the meta data difference between NC_DB and external data sources via POST /api/v2/meta/bases/{baseId}/meta-diff

Synchronise the meta data difference between NC_DB and external data sources in a given Source via POST /api/v2/meta/bases/{baseId}/meta-diff/{sourceId}

Create Base Shared Base via POST /api/v2/meta/bases/{baseId}/shared

Create a new source on a given base via POST /api/v2/meta/bases/{baseId}/sources

This endpoint allows you to create a new table in the specified base. via POST /api/v2/meta/bases/{baseId}/tables

Create a user and add it to the given base via POST /api/v2/meta/bases/{baseId}/users

Resend Invitation to a specific user via POST /api/v2/meta/bases/{baseId}/users/{userId}/resend-invite

Hide / show views based on user role via POST /api/v2/meta/bases/{baseId}/visibility-rules

Set a primary value on a given column via POST /api/v2/meta/columns/{columnId}/primary

Create a new comment in a row. Logged in Audit. via POST /api/v2/meta/comments

Test the DB Connection via POST /api/v2/meta/connection/test

Duplicate a base via POST /api/v2/meta/duplicate/{baseId}

Duplicate a base via POST /api/v2/meta/duplicate/{baseId}/{sourceId}

Duplicate a table via POST /api/v2/meta/duplicate/{baseId}/table/{tableId}

Create filter(s) in a given Hook via POST /api/v2/meta/hooks/{hookId}/filters

Test if the plugin is working with the given configurations via POST /api/v2/meta/plugins/test

Create a new column in a given Table via POST /api/v2/meta/tables/{tableId}/columns

Bulk create-update-delete columns via POST /api/v2/meta/tables/{tableId}/columns/bulk

Create a new form view in a given Table via POST /api/v2/meta/tables/{tableId}/forms

Create Gallery View via POST /api/v2/meta/tables/{tableId}/galleries

Create a new grid view in a given Table via POST /api/v2/meta/tables/{tableId}/grids

Create a hook in the given table via POST /api/v2/meta/tables/{tableId}/hooks

Test the hook in the given Table via POST /api/v2/meta/tables/{tableId}/hooks/test

Create a new Kanban View via POST /api/v2/meta/tables/{tableId}/kanbans

Create a new Map View via POST /api/v2/meta/tables/{tableId}/maps

Update the order of the given Table via POST /api/v2/meta/tables/{tableId}/reorder

Create a new column in a given View via POST /api/v2/meta/views/{viewId}/columns

Update the filter data in a given View via POST /api/v2/meta/views/{viewId}/filters

Hide All Columns in a given View via POST /api/v2/meta/views/{viewId}/hide-all

Create a shared view in a given View.. via POST /api/v2/meta/views/{viewId}/share

Show All Columns in a given View via POST /api/v2/meta/views/{viewId}/show-all

Update the sort data in a given View via POST /api/v2/meta/views/{viewId}/sorts

List workspaces via POST /api/v2/meta/workspaces

This API endpoint creates a new base within a given workspace, identified by the workspace ID. The API returns the created base in JSON format. via POST /api/v2/meta/workspaces/{workspaceId}/bases

Trigger export as job via POST /api/v2/public/export/{publicDataUuid}/{exportAs}

Upload attachment by URL. Used in Airtable Migration. via POST /api/v2/storage/upload-by-url

This API endpoint allows you to link records to a specific `Link field` and `Record ID`. The request payload is an array of record-ids from the adjacent table for linking purposes. Note that any existing links, if present, will be unaffected during this operation. via POST /api/v2/tables/{tableId}/links/{linkFieldId}/records/{recordId}

This API endpoint allows the creation of new records within a specified table. Records to be inserted are input as an array of key-value pair objects, where each key corresponds to a field name. Ensure that all the required fields are included in the payload, with exceptions for fields designated as auto-increment or those having default values. When dealing with 'Links' or 'Link To Another Record' field types, you should utilize the 'Create Link' API to insert relevant data. Certain read-only field types will be disregarded if included in the request. These field types include 'Look Up,' 'Roll Up,' 'Formula,' 'Auto Number,' 'Created By,' 'Updated By,' 'Created At,' 'Updated At,' 'Barcode,' and 'QR Code.' via POST /api/v2/tables/{tableId}/records