NocoDB v2

https://nocodb.com/apis/v2/
Admin
NocoDB is an open-source database management platform that provides REST APIs for managing table...
Tokens:50,724
Snippets:196
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create View Filter Response Example

Source: https://nocodb.com/apis/v2/meta

Example of a successful 200 OK response containing the created filter details.

```json
{
  * "source_id": "ds_g4ccx6e77h1dmi",
  * "comparison_op": "eq",
  * "comparison_sub_op": null,
  * "created_at": "2023-03-02 18:18:05",
  * "fk_column_id": "cl_d7ah9n2qfupgys",
  * "fk_hook_id": null,
  * "fk_parent_id": null,
  * "fk_view_id": "vw_b739e29vqmrxnf",
  * "id": "fi_xn647tpmdq8fu8",
  * "is_group": null,
  * "logical_op": "and",
  * "order": 1,
  * "base_id": "p_xm3thidrblw4n7",
  * "updated_at": "2023-03-02 18:18:05",
  * "value": "foo"

}
```

--------------------------------

### Get Source Schema Response

Source: https://nocodb.com/apis/v2/meta

Example JSON response for the Get Source Schema endpoint.

```json
{
  "alias": null,
  "config": "<ENCRYPTED>",
  "enabled": 1,
  "id": "ds_krsappzu9f8vmo",
  "inflection_column": "camelize",
  "inflection_table": "camelize",
  "is_meta": 1,
  "meta": null,
  "order": 1,
  "base_id": "p_01clqvzik3izk6",
  "type": "mysql2"
}
```

--------------------------------

### Create comment response

Source: https://nocodb.com/apis/v2/meta

Example response returned after successfully creating a comment.

```json
{
  "id": "adt_3sii7erfwrlegb",
  "source_id": null,
  "base_id": "p_63b4q0qengen1x",
  "fk_model_id": "md_5mipbdg6ketmv8",
  "row_id": "1",
  "created_by": "",
  "resolved_by": "",
  "parent_comment_id": null,
  "status": null,
  "comment": "bar",
  "created_at": "2023-03-13T09:39:14.225Z",
  "updated_at": "2023-03-13T09:39:14.225Z"
}
```

--------------------------------

### List View Sorts Response Example

Source: https://nocodb.com/apis/v2/meta

Example JSON response structure for a successful request to list sorts, including the sort records and pagination metadata.

```json
{
  "list": [
    {
      "id": "so_xd4t51uv60ghzl",
      "fk_column_id": "cl_l11b769pe2j1ce",
      "fk_model_id": "md_ehn5izr99m7d45",
      "source_id": "ds_3l9qx8xqksenrl",
      "direction": "desc",
      "order": 1,
      "base_id": "p_9sx43moxhqtjm3"
    }
  ],
  "pageInfo": {
    "isFirstPage": true,
    "isLastPage": true,
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### Get Kanban View Metadata Response

Source: https://nocodb.com/apis/v2/meta

Example JSON response structure when retrieving Kanban view metadata.

```json
{
  "id": "vw_wqs4zheuo5lgdy",
  "fk_grp_col_id": "cl_3704cxcbqt7sj7",
  "fk_view_id": "vw_wqs4zheuo5lgdy",
  "fk_cover_image_col_id": null,
  "columns": [
    {
      "id": "kvc_2skkg5mi1eb37f",
      "fk_column_id": "cl_hzos4ghyncqi4k",
      "fk_view_id": "vw_wqs4zheuo5lgdy",
      "source_id": "ds_hd4ojj0xpquaam",
      "base_id": "p_kzfl5lb0t3tcok",
      "title": "string",
      "show": 0,
      "order": "1"
    }
  ],
  "meta": null,
  "title": "My Kanban"
}
```

--------------------------------

### Create Gallery View Response

Source: https://nocodb.com/apis/v2/meta

Example response returned after successfully creating a Gallery view.

```json
{
  * "id": "vw_qp94qfnvffgk5f",
  * "source_id": "ds_a95vextjl510z7",
  * "base_id": "p_slkm6i3v31q4bc",
  * "fk_model_id": "md_8hr3xndx8umuce",
  * "title": "Gallery-1",
  * "type": 2,
  * "show_system_fields": null,
  * "lock_type": "collaborative",
  * "uuid": null,
  * "password": null,
  * "show": true,
  * "order": 3,
  * "created_at": "2023-03-13T07:29:18.707Z",
  * "updated_at": "2023-03-13T07:29:18.707Z",
  * "meta": { }

}
```

--------------------------------

### Get Gallery View Metadata Response

Source: https://nocodb.com/apis/v2/meta

Example response structure for retrieving metadata of a specific Gallery view.

```json
{
  * "alias": "string",
  * "columns": [
    * {
      * "fk_col_id": "string",
      * "fk_gallery_id": "string",
      * "help": "string",
      * "id": "string",
      * "label": "string"
}
],
  * "cover_image": "string",
  * "cover_image_idx": 0,
  * "deleted": true,
  * "fk_cover_image_col_id": "string",
  * "fk_model_id": "string",
  * "fk_view_id": "string",
  * "lock_type": "collaborative",
  * "next_enabled": true,
  * "order": 0,
  * "prev_enabled": true,
  * "restrict_number": "string",
  * "restrict_size": "string",
  * "restrict_types": "string",
  * "title": "string"

}
```

--------------------------------

### GET /api/v2/meta/bases/

Source: https://nocodb.com/apis/v2/meta

Retrieves a list of all available bases for the OSS version of NocoDB.

```APIDOC
## GET /api/v2/meta/bases/

### Description
Retrieve a list of all available bases (OSS version).

### Method
GET

### Endpoint
/api/v2/meta/bases/

### Parameters
#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **list** (array) - List of bases
- **pageInfo** (object) - Pagination information

#### Response Example
{
  "list": [
    {
      "id": "p_124hhlkbeasewh",
      "title": "my-base",
      "description": "This is my base description"
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### Create Source Response Sample

Source: https://nocodb.com/apis/v2/meta

Example JSON response returned upon a successful source creation.

```json
{
  * "alias": null,
  * "config": "<ENCRYPTED>",
  * "enabled": 1,
  * "id": "ds_krsappzu9f8vmo",
  * "inflection_column": "camelize",
  * "inflection_table": "camelize",
  * "is_meta": 1,
  * "meta": null,
  * "order": 1,
  * "base_id": "p_01clqvzik3izk6",
  * "type": "mysql2"

}
```

--------------------------------

### Get Form View Metadata Response

Source: https://nocodb.com/apis/v2/meta

Example JSON response structure returned when successfully retrieving form view metadata.

```json
{
  "source_id": "ds_g4ccx6e77h1dmi",
  "banner_image_url": {
    "mimetype": "image/jpg",
    "size": 32903,
    "title": "Random-Pictures-of-Conceptual-and-Creative-Ideas-02.jpg",
    "path": "download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//iDL5ednaHz2j2Sa3Cl.jpg",
    "signedPath": "dltemp/lNoLbqB62Jdo5Rmp/1709308800000/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//iDL5ednaHz2j2Sa3Cl.jpg"
},
  "columns": [
    {
      "id": "fvc_ugj9zo5bzocxtl",
      "source_id": "ds_g4ccx6e77h1dmi",
      "base_id": "p_xm3thidrblw4n7",
      "fk_view_id": "vw_kdf5cr7qmhksek",
      "fk_column_id": "cl_phvuuwjrzcdo0g",
      "uuid": null,
      "label": null,
      "help": null,
      "description": null,
      "required": null,
      "show": 0,
      "order": 1,
      "created_at": "2023-03-04 16:40:47",
      "updated_at": "2023-03-04 16:40:47",
      "meta": { }
}
],
  "email": "user@example.com",
  "fk_model_id": "md_rsu68aqjsbyqtl",
  "heading": "My Form",
  "lock_type": "collaborative",
  "logo_url": null,
  "meta": null,
  "redirect_after_secs": null,
  "redirect_url": null,
  "show_blank_form": 0,
  "subheading": "My Form Subheading",
  "submit_another_form": 0,
  "success_msg": "Thank you for the submission.",
  "title": "Form View 1"

}
```

--------------------------------

### Create Table Response Sample

Source: https://nocodb.com/apis/v2/meta

Example JSON response returned after a successful table creation request.

```json
{
  "source_id": "ds_g4ccx6e77h1dmi",
  "columns": [
    {
      "ai": 0,
      "au": 0,
      "source_id": "ds_g4ccx6e77h1dmi",
      "cc": "",
      "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP",
      "clen": null,
      "column_name": "updated_at",
      "cop": "4",
      "created_at": "2023-03-02 17:04:06",
      "csn": null,
      "ct": "timestamp",
      "deleted": null,
      "dt": "timestamp",
      "dtx": "specificType",
      "dtxp": "0",
      "dtxs": null,
      "fk_model_id": "md_rsu68aqjsbyqtl",
      "id": "cl_m4wkaqgqqjzoeh",
      "meta": null,
      "np": null,
      "ns": null,
      "order": 4,
      "pk": 0,
      "base_id": "p_xm3thidrblw4n7",
      "pv": null,
      "rqd": 0,
      "system": 0,
      "title": "UpdatedAt",
      "uidt": "DateTime",
      "un": 0,
      "unique": 0,
      "updated_at": "2023-03-02 17:04:06",
      "validate": null,
      "virtual": null
},
    {
      "ai": 0,
      "au": 0,
      "source_id": "ds_g4ccx6e77h1dmi",
      "cc": "",
      "cdf": "CURRENT_TIMESTAMP",
      "clen": null,
      "column_name": "created_at",
      "cop": "3",
      "created_at": "2023-03-02 17:04:06",
      "csn": null,
      "ct": "timestamp",
      "deleted": null,
      "dt": "timestamp",
      "dtx": "specificType",
      "dtxp": "0",
      "dtxs": null,
      "fk_model_id": "md_rsu68aqjsbyqtl",
      "id": "cl_jpl0qu4gj4rexq",
      "meta": null,
      "np": null,
      "ns": null,
      "order": 3,
      "pk": 0,
      "base_id": "p_xm3thidrblw4n7",
      "pv": null,
      "rqd": 0,
      "system": 0,
      "title": "CreatedAt",
      "uidt": "DateTime",
      "un": 0,
      "unique": 0,
      "updated_at": "2023-03-02 17:04:06",
      "validate": null,
      "virtual": null
},
    {
      "ai": 0,
      "au": 0,
      "source_id": "ds_g4ccx6e77h1dmi",
      "cc": "",
      "cdf": null,
      "clen": null,
      "column_name": "title",
      "cop": "2",
      "created_at": "2023-03-02 17:04:06",
      "csn": null,
      "ct": "varchar",
      "deleted": null,
      "dt": "varchar",
      "dtx": "specificType",
      "dtxp": "45",
      "dtxs": null,
      "fk_model_id": "md_rsu68aqjsbyqtl",
      "id": "cl_jpl0qu4gj4rexq",
      "meta": null,
      "np": null,
      "ns": null,
      "order": 2,
      "pk": 0,
      "base_id": "p_xm3thidrblw4n7",
      "pv": null,
      "rqd": 0,
      "system": 0,
      "title": "Title",
      "uidt": "SingleLineText",
      "un": 0,
      "unique": 0,
      "updated_at": "2023-03-02 17:04:06",
      "validate": null,
      "virtual": null
}
```

--------------------------------

### Create Grid View Response

Source: https://nocodb.com/apis/v2/meta

Example response object returned after successfully creating a grid view.

```json
{
  * "id": "vw_o50jiw9v2txktv",
  * "source_id": "ds_a95vextjl510z7",
  * "base_id": "p_slkm6i3v31q4bc",
  * "fk_model_id": "md_8hr3xndx8umuce",
  * "title": "Grid-1",
  * "type": 3,
  * "show_system_fields": null,
  * "lock_type": "collaborative",
  * "uuid": null,
  * "password": null,
  * "show": true,
  * "order": 2,
  * "created_at": "2023-03-13T07:29:16.610Z",
  * "updated_at": "2023-03-13T07:29:16.610Z",
  * "meta": { }

}
```

--------------------------------

### GET /api/v2/meta/bases/{baseId}/sources/

Source: https://nocodb.com/apis/v2/meta

Lists all data sources within a specified base.

```APIDOC
## GET /api/v2/meta/bases/{baseId}/sources/

### Description
This endpoint allows you to list all data sources within a specified base. The API returns a paginated list of data sources.

### Method
GET

### Endpoint
/api/v2/meta/bases/{baseId}/sources/

### Parameters
#### Path Parameters
- **baseId** (string) - Required - Unique Base ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **list** (array) - List of data sources
- **pageInfo** (object) - Pagination information (totalRows, page, pageSize, isFirstPage, isLastPage)

#### Response Example
{
  "list": [
    {
      "alias": null,
      "config": "<ENCRYPTED>",
      "enabled": 1,
      "id": "ds_krsappzu9f8vmo",
      "inflection_column": "camelize",
      "inflection_table": "camelize",
      "is_meta": 1,
      "meta": null,
      "order": 1,
      "base_id": "p_01clqvzik3izk6",
      "type": "mysql2"
    }
  ],
  "pageInfo": {
    "isFirstPage": true,
    "isLastPage": true,
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### Update Grid View Response

Source: https://nocodb.com/apis/v2/meta

Example response returned after successfully updating a grid view.

```json
1
```

--------------------------------

### Create Column Error Response

Source: https://nocodb.com/apis/v2/meta

Example JSON response for a 400 Bad Request error.

```json
{
  * "msg": "BadRequest [Error]: <ERROR MESSAGE>"

}
```

--------------------------------

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

Source: https://nocodb.com/apis/v2/meta

Lists all tables associated with a specific base and source.

```APIDOC
## GET /api/v2/meta/bases/{baseId}/{sourceId}/tables

### Description
List all tables in a given Base and Source.

### Method
GET

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

### Parameters
#### Path Parameters
- **baseId** (string) - Required - Unique Base ID
- **sourceId** (string) - Required - Unique Source ID

#### Query Parameters
- **page** (number) - Optional - Page number
- **pageSize** (number) - Optional - Number of items per page
- **sort** (string) - Optional - Sort criteria
- **includeM2M** (boolean) - Optional - Include many-to-many tables

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **list** (array) - List of table objects
- **pageInfo** (object) - Pagination metadata

### Response Example
{
  "list": [
    {
      "id": "md_5hua2iqloqirhd",
      "source_id": "ds_jxuewivwbxeum2",
      "base_id": "p_tbhl1hnycvhe5l",
      "table_name": "nc_b84e___Sheet-1",
      "title": "Sheet-1",
      "type": "table",
      "enabled": true
    }
  ],
  "pageInfo": {
    "isFirstPage": true,
    "isLastPage": true,
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### GET /api/v2/meta/kanbans/{kanbanViewId}

Source: https://nocodb.com/apis/v2/meta

Retrieves the metadata for a specific Kanban view using its unique ID.

```APIDOC
## GET /api/v2/meta/kanbans/{kanbanViewId}

### Description
Get the Kanban View data by Kanban ID.

### Method
GET

### Endpoint
/api/v2/meta/kanbans/{kanbanViewId}

### Parameters
#### Path Parameters
- **kanbanViewId** (string) - Required - Unique Kanban View ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **id** (string) - Kanban View ID
- **fk_grp_col_id** (string) - Group column ID
- **fk_view_id** (string) - View ID
- **fk_cover_image_col_id** (string|null) - Cover image column ID
- **columns** (array) - List of columns in the view
- **meta** (object|null) - Metadata object
- **title** (string) - Kanban title
```

--------------------------------

### GET /api/v2/meta/workspaces/{workspaceId}/bases

Source: https://nocodb.com/apis/v2/meta

Fetches a paginated list of bases associated with the specified workspace ID.

```APIDOC
## GET /api/v2/meta/workspaces/{workspaceId}/bases

### Description
This API fetches a list of bases associated with the specified workspace ID. The response is paginated and includes metadata and configuration for each base.

### Method
GET

### Endpoint
/api/v2/meta/workspaces/{workspaceId}/bases

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

#### Header Parameters
- **xc-token** (string) - Required - API Token.

### Response
#### Success Response (200)
- **list** (array) - A list of base objects.
- **pageInfo** (object) - Pagination metadata including totalRows, page, pageSize, isFirstPage, and isLastPage.

#### Response Example
{
  "list": [
    {
      "id": "p_124hhlkbeasewh",
      "title": "my-base",
      "description": "This is my base description",
      "sources": []
    }
  ],
  "pageInfo": {
    "isFirstPage": true,
    "isLastPage": true,
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### Create Table Request Payload

Source: https://nocodb.com/apis/v2/meta

Example JSON payload for creating a new table with predefined columns.

```json
{
  "columns": [
    {
      "ai": false,
      "altered": 1,
      "cdf": "CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP",
      "ck": false,
      "clen": 45,
      "column_name": "updated_at",
      "ct": "varchar(45)",
      "dt": "timestamp",
      "dtx": "specificType",
      "dtxp": "",
      "dtxs": "",
      "np": null,
      "nrqd": true,
      "ns": null,
      "pk": false,
      "rqd": false,
      "title": "UpdatedAt",
      "uicn": "",
      "uidt": "DateTime",
      "uip": "",
      "un": false
},
    {
      "ai": false,
      "altered": 1,
      "cdf": "CURRENT_TIMESTAMP",
      "ck": false,
      "clen": 45,
      "column_name": "created_at",
      "ct": "varchar(45)",
      "dt": "timestamp",
      "dtx": "specificType",
      "dtxp": "",
      "dtxs": "",
      "np": null,
      "nrqd": true,
      "ns": null,
      "pk": false,
      "rqd": false,
      "title": "CreatedAt",
      "uicn": "",
      "uidt": "DateTime",
      "uip": "",
      "un": false
},
    {
      "ai": false,
      "altered": 1,
      "cdf": null,
      "ck": false,
      "clen": 45,
      "column_name": "title",
      "ct": "varchar(45)",
      "dt": "varchar",
      "dtx": "specificType",
      "dtxp": "45",
      "dtxs": "",
      "np": null,
      "nrqd": true,
      "ns": null,
      "pk": false,
      "rqd": false,
      "title": "Title",
      "uicn": "",
      "uidt": "SingleLineText",
      "uip": "",
      "un": false
},
    {
      "ai": true,
      "altered": 1,
      "cdf": null,
      "ck": false,
      "clen": null,
      "column_name": "id",
      "ct": "int(11)",
      "dt": "int",
      "dtx": "integer",
      "dtxp": "11",
      "dtxs": "",
      "np": 11,
      "nrqd": false,
      "ns": 0,
      "pk": true,
      "rqd": true,
      "title": "Id",
      "uicn": "",
      "uidt": "ID",
      "uip": "",
      "un": true
}
],
  "table_name": "Sheet-1",
  "title": "Sheet-1"

}
```

--------------------------------

### List View Filters Response

Source: https://nocodb.com/apis/v2/meta

Example of a paginated response containing a list of filters for a specific view.

```json
{
  * "list": [
    * {
      * "source_id": "ds_g4ccx6e77h1dmi",
      * "comparison_op": "eq",
      * "comparison_sub_op": null,
      * "created_at": "2023-03-02 18:18:05",
      * "fk_column_id": "cl_d7ah9n2qfupgys",
      * "fk_hook_id": null,
      * "fk_parent_id": null,
      * "fk_view_id": "vw_b739e29vqmrxnf",
      * "id": "fi_xn647tpmdq8fu8",
      * "is_group": null,
      * "logical_op": "and",
      * "order": 1,
      * "base_id": "p_xm3thidrblw4n7",
      * "updated_at": "2023-03-02 18:18:05",
      * "value": "foo"
}
],
  * "pageInfo": {
    * "isFirstPage": true,
    * "isLastPage": true,
    * "page": 1,
    * "pageSize": 10,
    * "totalRows": 1
}

}
```

--------------------------------

### Get Filter Metadata Response

Source: https://nocodb.com/apis/v2/meta

Example JSON response structure returned when successfully retrieving filter metadata.

```json
{
  "source_id": "ds_g4ccx6e77h1dmi",
  "comparison_op": "eq",
  "comparison_sub_op": null,
  "created_at": "2023-03-02 18:18:05",
  "fk_column_id": "cl_d7ah9n2qfupgys",
  "fk_hook_id": null,
  "fk_parent_id": null,
  "fk_view_id": "vw_b739e29vqmrxnf",
  "id": "fi_xn647tpmdq8fu8",
  "is_group": null,
  "logical_op": "and",
  "order": 1,
  "base_id": "p_xm3thidrblw4n7",
  "updated_at": "2023-03-02 18:18:05",
  "value": "foo"
}
```

--------------------------------

### List Bases (OSS)

Source: https://nocodb.com/apis/v2/meta

Returns a paginated list of base objects containing source configurations and metadata.

```json
{
  * "list": [
    * {
      * "sources": [
        * {
          * "alias": "string",
          * "config": null,
          * "created_at": "2023-03-01 14:27:36",
          * "enabled": true,
          * "id": "string",
          * "inflection_column": "camelize",
          * "inflection_table": "camelize",
          * "is_meta": true,
          * "order": 1,
          * "base_id": "string",
          * "type": "mysql2",
          * "updated_at": "2023-03-01 14:27:36"
}
],
      * "color": "#24716E",
      * "created_at": "2023-03-01 14:27:36",
      * "deleted": true,
      * "description": "This is my base description",
      * "id": "p_124hhlkbeasewh",
      * "is_meta": true,
      * "meta": { },
      * "order": 0,
      * "prefix": "nc_vm5q__",
      * "status": "string",
      * "title": "my-base",
      * "updated_at": "2023-03-01 14:27:36"
}
],
  * "pageInfo": {
    * "isFirstPage": true,
    * "isLastPage": true,
    * "page": 1,
    * "pageSize": 10,
    * "totalRows": 1
}

}
```

--------------------------------

### POST /api/v2/meta/bases/

Source: https://nocodb.com/apis/v2/meta

Creates a new base in the NocoDB system.

```APIDOC
## POST /api/v2/meta/bases/

### Description
Create a new base in the system (OSS version).

### Method
POST

### Endpoint
/api/v2/meta/bases/

### Parameters
#### Header Parameters
- **xc-token** (string) - Required - API Token.

#### Request Body
- **title** (string) - Required - Base Title (1-128 characters).
- **description** (string) - Optional - Base Description.
- **meta** (object) - Optional - Base Meta.
- **fk_workspace_id** (string) - Optional - Workspace ID.

### Request Example
{
  "title": "my-base",
  "description": "This is my base description"
}

### Response
#### Success Response (200)
- **id** (string) - Base ID
- **title** (string) - Base Title
- **description** (string) - Base Description

#### Response Example
{
  "id": "p_124hhlkbeasewh",
  "title": "my-base",
  "description": "This is my base description"
}
```

--------------------------------

### GET /api/v2/meta/galleries/{galleryViewId}

Source: https://nocodb.com/apis/v2/meta

Retrieves the metadata for a specific gallery view.

```APIDOC
## GET /api/v2/meta/galleries/{galleryViewId}

### Description
Retrieves the metadata for a specific gallery view using its ID.

### Method
GET

### Endpoint
/api/v2/meta/galleries/{galleryViewId}

### Parameters
#### Path Parameters
- **galleryViewId** (string) - Required - Unique Gallery View ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **title** (string) - View Title
- **columns** (array) - List of column configurations
- **cover_image** (string) - Cover image path

#### Response Example
{
  "title": "string",
  "columns": [],
  "cover_image": "string"
}
```

--------------------------------

### Create Shared View Response Sample

Source: https://nocodb.com/apis/v2/meta

Example JSON response structure returned after successfully creating a shared view.

```json
{
  "meta": { },
  "password": "123456789"
}
```

--------------------------------

### GET /api/v2/meta/comments

Source: https://nocodb.com/apis/v2/meta

Retrieves a list of all comments associated with a specific row and model.

```APIDOC
## GET /api/v2/meta/comments

### Description
List all comments.

### Method
GET

### Endpoint
/api/v2/meta/comments

### Parameters
#### Query Parameters
- **row_id** (string) - Required - Row ID
- **fk_model_id** (string) - Required - Foreign Key to Model

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **list** (array) - List of comment objects

#### Response Example
{
  "list": [
    {
      "id": "adt_3sii7erfwrlegb",
      "base_id": "p_63b4q0qengen1x",
      "fk_model_id": "md_5mipbdg6ketmv8",
      "row_id": "1",
      "comment": "bar",
      "created_at": "2023-03-13T09:39:14.225Z",
      "updated_at": "2023-03-13T09:39:14.225Z"
    }
  ]
}
```

--------------------------------

### Create Base Response Sample

Source: https://nocodb.com/apis/v2/meta

JSON structure returned by the server upon a successful base creation.

```json
{
  "sources": [
    {
      "alias": "string",
      "config": null,
      "enabled": true,
      "id": "string",
      "inflection_column": "camelize",
      "inflection_table": "camelize",
      "is_meta": true,
      "order": 1,
      "base_id": "string",
      "type": "mysql2",
      "updated_at": "2023-03-01 14:27:36"
}
],
  "color": "#24716E",
  "created_at": "2023-03-01 14:27:36",
  "deleted": true,
  "description": "This is my base description",
  "id": "p_124hhlkbeasewh",
  "is_meta": true,
  "meta": { },
  "order": 0,
  "prefix": "nc_vm5q__",
  "status": "string",
  "title": "my-base"

}
```

--------------------------------

### GET /api/v2/meta/sorts/{sortId}

Source: https://nocodb.com/apis/v2/meta

Retrieves the sort metadata for a specific sort ID.

```APIDOC
## GET /api/v2/meta/sorts/{sortId}

### Description
Get the sort data by Sort ID.

### Method
GET

### Endpoint
/api/v2/meta/sorts/{sortId}

### Parameters
#### Path Parameters
- **sortId** (string) - Required - Unique Sort ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **id** (string) - Sort ID
- **fk_column_id** (string) - Foreign Key to Column
- **fk_model_id** (string) - Foreign Key to Model
- **source_id** (string) - Source ID
- **direction** (string) - Sort direction
- **order** (integer) - Sort order
- **base_id** (string) - Base ID

#### Response Example
{
  "id": "so_xd4t51uv60ghzl",
  "fk_column_id": "cl_l11b769pe2j1ce",
  "fk_model_id": "md_ehn5izr99m7d45",
  "source_id": "ds_3l9qx8xqksenrl",
  "direction": "desc",
  "order": 1,
  "base_id": "p_9sx43moxhqtjm3"
}
```

--------------------------------

### Update Shared View Response Sample

Source: https://nocodb.com/apis/v2/meta

Example JSON response returned after updating a shared view, containing the full view configuration object.

```json
{
  "source_id": "ds_g4ccx6e77h1dmi",
  "created_at": "2023-03-02 17:46:31",
  "fk_model_id": "md_mhs9z4r2ak98x0",
  "id": "vw_lg052cnc1c26kf",
  "lock_type": "collaborative",
  "meta": { },
  "order": 1,
  "password": null,
  "base_id": "p_xm3thidrblw4n7",
  "show": 1,
  "show_system_fields": null,
  "title": "Sheet-1",
  "type": 3,
  "updated_at": "2023-03-02 17:46:31",
  "uuid": null,
  "view": {
    "source_id": "ds_g4ccx6e77h1dmi",
    "created_at": "2023-03-02 17:46:31",
    "fk_view_id": "vw_lg052cnc1c26kf",
    "meta": null,
    "base_id": "p_xm3thidrblw4n7",
    "row_height": null,
    "updated_at": "2023-03-02 17:46:31",
    "uuid": null
  }
}
```

--------------------------------

### GET /api/v2/meta/filters/{filterGroupId}/children

Source: https://nocodb.com/apis/v2/meta

Retrieves the children of a specific filter group.

```APIDOC
## GET /api/v2/meta/filters/{filterGroupId}/children

### Description
Get Filter Group Children of a given group ID.

### Method
GET

### Endpoint
/api/v2/meta/filters/{filterGroupId}/children

### Parameters
#### Path Parameters
- **filterGroupId** (string) - Required - Filter Group ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **list** (array) - List of filter objects
- **pageInfo** (object) - Pagination information

#### Response Example
{
  "list": [
    {
      "source_id": "ds_g4ccx6e77h1dmi",
      "comparison_op": "eq",
      "comparison_sub_op": null,
      "created_at": "2023-03-02 18:18:05",
      "fk_column_id": "cl_d7ah9n2qfupgys",
      "fk_hook_id": null,
      "fk_parent_id": null,
      "fk_view_id": "vw_b739e29vqmrxnf",
      "id": "fi_xn647tpmdq8fu8",
      "is_group": null,
      "logical_op": "and",
      "order": 1,
      "base_id": "p_xm3thidrblw4n7",
      "updated_at": "2023-03-02 18:18:05",
      "value": "foo"
    }
  ],
  "pageInfo": {
    "isFirstPage": true,
    "isLastPage": true,
    "page": 1,
    "pageSize": 10,
    "totalRows": 1
  }
}
```

--------------------------------

### GET /api/v2/meta/forms/{formViewId}

Source: https://nocodb.com/apis/v2/meta

Retrieves the metadata for a specific form view by its ID.

```APIDOC
## GET /api/v2/meta/forms/{formViewId}

### Description
Retrieves the form data and configuration metadata for a specific Form View identified by its unique ID.

### Method
GET

### Endpoint
/api/v2/meta/forms/{formViewId}

### Parameters
#### Path Parameters
- **formViewId** (string) - Required - Unique Form View ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

### Response
#### Success Response (200)
- **source_id** (string) - Source ID
- **banner_image_url** (object) - Banner image details
- **columns** (array) - List of column configurations
- **email** (string) - Associated email
- **fk_model_id** (string) - Foreign key model ID
- **heading** (string) - Form heading
- **lock_type** (string) - Lock type
- **subheading** (string) - Form subheading
- **success_msg** (string) - Success message
- **title** (string) - Form title

#### Response Example
{
  "source_id": "ds_g4ccx6e77h1dmi",
  "heading": "My Form",
  "subheading": "My Form Subheading",
  "success_msg": "Thank you for the submission.",
  "title": "Form View 1"
}
```

--------------------------------

### Create Base Response Sample

Source: https://nocodb.com/apis/v2/meta

JSON structure returned by the API upon a successful base creation.

```json
{
  * "sources": [
    * {
      * "alias": "string",
      * "config": null,
      * "enabled": true,
      * "id": "string",
      * "inflection_column": "camelize",
      * "inflection_table": "camelize",
      * "is_meta": true,
      * "order": 1,
      * "base_id": "string",
      * "type": "mysql2",
      * "updated_at": "2023-03-01 14:27:36"
}
],
  * "color": "#24716E",
  * "created_at": "2023-03-01 14:27:36",
  * "deleted": true,
  * "description": "This is my base description",
  * "id": "p_124hhlkbeasewh",
  * "is_meta": true,
  * "meta": { },
  * "order": 0,
  * "prefix": "nc_vm5q__",
  * "status": "string",
  * "title": "my-base"

}
```

--------------------------------

### POST /api/v2/meta/bases/{baseId}/sources/

Source: https://nocodb.com/apis/v2/meta

Creates a new source on a given base.

```APIDOC
## POST /api/v2/meta/bases/{baseId}/sources/

### Description
Create a new source on a given base.

### Method
POST

### Endpoint
/api/v2/meta/bases/{baseId}/sources/

### Parameters
#### Path Parameters
- **baseId** (string) - Required - Unique Base ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

#### Request Body
- **alias** (StringOrNull) - Optional - Alias for the source
- **integration_title** (StringOrNull) - Optional - Integration title
- **fk_integration_id** (StringOrNull) - Optional - Foreign key integration ID
- **config** (any) - Optional - Source Configuration
- **enabled** (Bool) - Optional - Enabled status
- **id** (string) - Optional - Unique Source ID
- **inflection_column** (string) - Optional - Inflection for columns
- **inflection_table** (string) - Optional - Inflection for tables
- **is_meta** (Bool) - Optional - Is meta flag
- **is_local** (Bool) - Optional - Is local flag
- **is_schema_readonly** (Bool) - Optional - Is schema readonly flag
- **is_data_readonly** (Bool) - Optional - Is data readonly flag
- **order** (number) - Optional - The order of the list of sources
- **base_id** (string) - Optional - The base ID that this source belongs to
- **type** (string) - Optional - DB Type (mysql, mysql2, pg, snowflake, sqlite3, databricks)
- **external** (boolean) - Optional - External flag

### Request Example
{
  "alias": null,
  "config": "<ENCRYPTED>",
  "enabled": 1,
  "id": "ds_krsappzu9f8vmo",
  "inflection_column": "camelize",
  "inflection_table": "camelize",
  "is_meta": 1,
  "meta": null,
  "order": 1,
  "base_id": "p_01clqvzik3izk6",
  "type": "mysql2",
  "external": false
}

### Response
#### Success Response (200)
- **alias** (StringOrNull) - Alias
- **config** (any) - Configuration
- **enabled** (Bool) - Enabled status
- **id** (string) - Source ID
- **inflection_column** (string) - Column inflection
- **inflection_table** (string) - Table inflection
- **is_meta** (Bool) - Is meta
- **meta** (any) - Meta
- **order** (number) - Order
- **base_id** (string) - Base ID
- **type** (string) - DB Type

#### Response Example
{
  "alias": null,
  "config": "<ENCRYPTED>",
  "enabled": 1,
  "id": "ds_krsappzu9f8vmo",
  "inflection_column": "camelize",
  "inflection_table": "camelize",
  "is_meta": 1,
  "meta": null,
  "order": 1,
  "base_id": "p_01clqvzik3izk6",
  "type": "mysql2"
}
```

--------------------------------

### POST /api/v2/meta/bases/{baseId}/users

Source: https://nocodb.com/apis/v2/meta

Create a user and add it to the given base.

```APIDOC
## POST /api/v2/meta/bases/{baseId}/users

### Description
Create a user and add it to the given base.

### Method
POST

### Endpoint
/api/v2/meta/bases/{baseId}/users

### Parameters
#### Path Parameters
- **baseId** (string) - Required - Unique Base ID

#### Header Parameters
- **xc-token** (string) - Required - API Token

#### Request Body
- **email** (string) - Required - Base User Email
- **roles** (string) - Required - Base User Role (Enum: "no-access", "commenter", "editor", "guest", "owner", "viewer", "creator", "inherit")

### Request Example
{
  "email": "user@example.com",
  "roles": "owner"
}

### Response
#### Success Response (200)
- **msg** (string) - The user has been invited successfully
```
Tokens:
Raw