{
"openapi": "3.1.0",
"info": {
"title": "nocodb",
"version": "1.0"
},
"servers": [
"url": "http://localhost:8080"
}
],
"paths": {
"/api/v1/auth/user/signup": {
"post": {
"summary": "Signup",
"operationId": "auth-signup",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
"examples": {
"Successful registration response": {
"value": {
"token": "string"
"400": {
"description": "Bad Request",
"msg": {
"Invalid email": {
"msg": "Invalid email"
"Invalid invite url": {
"msg": "Invalid invite url"
"Expired invite url": {
"msg": "Expired invite url, Please contact super admin to get a new invite url"
"User already exist": {
"msg": "User already exist"
"Invite only signup": {
"msg": "Not allowed to signup, contact super admin"
"401": {
"description": "Unauthorized"
"403": {
"description": "Forbidden"
"tags": [
"Auth"
"requestBody": {
"$ref": "#/components/requestBodies/Signup"
"description": "Create a new user with provided email and password and first user is marked as super admin. "
"/api/v1/auth/user/signin": {
"summary": "Signin",
"operationId": "auth-signin",
"email": {
"password": {
"required": [
"email",
"password"
]
"example-1": {
"email": "user@nocodb.com",
"password": "Password"
"description": "Authenticate existing user with their email and password. Successful login will return a JWT access-token. "
"parameters": []
"/api/v1/auth/user/me": {
"parameters": [],
"get": {
"summary": "User info",
"operationId": "auth-me",
"$ref": "#/components/schemas/UserInfo"
"id": "string",
"email": "string",
"email_verified": "string",
"firstname": "string",
"lastname": "string",
"roles": {
"editor": true
"description": "Returns authenticated user info",
"parameters": [
"in": "query",
"name": "project_id",
"description": "Pass project id to get project specific roles along with user info"
"/api/v1/auth/password/forgot": {
"summary": "Password forgot",
"operationId": "auth-password-forgot",
"description": "OK"
"description": "Emails user with a reset url.",
"description": "Pass registered user email id in request body"
"/api/v1/auth/password/change": {
"summary": "Password change",
"operationId": "auth-password-change",
"Success response": {
"msg": "Password updated successfully"
"description": "Bad request",
"Missing params": {
"msg": "Missing new/old password"
"Wrong password": {
"msg": "Current password is wrong"
"description": "Change password of authenticated user with a new one.",
"currentPassword": {
"newPassword": {
"currentPassword": "string",
"newPassword": "string"
"description": "Old password need to be passed along with new password for changing password."
"/api/v1/auth/token/validate/{token}": {
"summary": "Reset token verify",
"operationId": "auth-password-reset-token-validate",
"description": "Validtae password reset url token.",
"name": "token",
"in": "path",
"required": true
"/api/v1/auth/email/validate/{token}": {
"summary": "Verify email",
"operationId": "auth-email-validate",
"description": "Api for verifying email where token need to be passed which is shared to user email.",
"/api/v1/auth/password/reset/{token}": {
"summary": "Password reset",
"operationId": "auth-password-reset",
"description": "Update user password to new by using reset token.",
"new_password": {
"/api/v1/auth/token/refresh": {
"summary": "Refresh token",
"operationId": "auth-token-refresh",
"description": "",
"/api/v1/db/meta/projects/{projectId}/users": {
"summary": "Project users",
"operationId": "auth-project-user-list",
"users": {
"list": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/components/schemas/User"
"pageInfo": {
"$ref": "#/components/schemas/Paginated"
"list",
"pageInfo"
"name": "projectId",
"summary": "Project User Add",
"operationId": "auth-project-user-add",
"schema": {}
"/api/v1/db/meta/projects/{projectId}/info": {
"summary": "Project info",
"operationId": "project-meta-get",
"Node": {
"Arch": {
"Platform": {
"Docker": {
"type": "boolean"
"Database": {
"ProjectOnRootDB": {
"RootDB": {
"PackageVersion": {
"Project"
"type": "number",
"minimum": 1,
"multipleOf": 1
"in": "query"
"/api/v1/db/meta/projects/{projectId}/users/{userId}": {
"name": "userId",
"patch": {
"summary": "Project user update",
"operationId": "auth-project-user-update",
"delete": {
"summary": "Project user remove",
"operationId": "auth-project-user-remove",
"/api/v1/db/meta/projects/{projectId}/visibility-rules": {
"summary": "UI ACL",
"operationId": "project-model-visibility-list",
"items": {}
"name": "includeM2M"
"summary": "",
"operationId": "project-model-visibility-set",
"/api/v1/db/meta/projects/": {
"summary": "Project list",
"operationId": "project-list",
"201": {
"$ref": "#/components/responses/ProjectList"
"description": "Read project details",
"type": "number"
"name": "page"
"name": "pageSize"
"name": "sort"
"in": "header",
"name": "xc-auth",
"description": "Auth token"
"summary": "Project create",
"operationId": "project-create",
"$ref": "#/components/schemas/Project"
"allOf": [
"external": {
"type": "boolean",
"default": false
"/api/v1/db/meta/projects/{projectId}": {
"summary": "Project read",
"operationId": "project-read",
"properties": {}
"summary": "Project delete",
"operationId": "project-delete",
"summary": "Project update",
"operationId": "project-update",
"/api/v1/db/meta/projects/{projectId}/shared": {
"operationId": "project-shared-base-get",
"uuid": {
"url": {
"operationId": "project-shared-base-disable",
"operationId": "project-shared-base-create",
"operationId": "project-shared-base-update",
"description": ""
"/api/v1/db/meta/projects/{projectId}/cost": {
"summary": "Project compare cost",
"operationId": "project-cost",
"description": "Project compare cost",
"/api/v1/db/meta/projects/{projectId}/tables": {
"operationId": "db-table-create",
"$ref": "#/components/schemas/Table"
"$ref": "#/components/schemas/TableReq"
"DB table"
"operationId": "db-table-list",
"$ref": "#/components/responses/TableList"
"name": "xc-auth"
"/api/v1/db/meta/tables/{tableId}": {
"name": "tableId",
"operationId": "db-table-read",
"$ref": "#/components/schemas/TableInfo"
"fk_project_id": "string",
"fk_base_id": "string",
"title": "string",
"alias": "string",
"type": "string",
"enabled": "string",
"parent_id": "string",
"show_as": "string",
"tags": "string",
"pinned": true,
"deleted": true,
"order": 0,
"column": [
"base_id": "string",
"fk_model_id": "string",
"ui_data_type": "string",
"data_type": "string",
"numeric_precision": "string",
"numeric_scale": "string",
"character_maximum_length": "string",
"column_ordinal_position": "string",
"primary_key": "string",
"primary_value": "string",
"rqd": "string",
"un": "string",
"column_type": "string",
"auto_increment": "string",
"unique": "string",
"column_default": "string",
"column_comment": "string",
"character_set_name": "string",
"data_type_x": "string",
"data_type_x_precision": "string",
"data_type_x_scale": "string",
"auto_update_timestamp": true,
"visible": true,
"colOptions": {
"virtual": true,
"fk_column_id": "string",
"fk_child_column_id": "string",
"fk_parent_column_id": "string",
"fk_mm_model_id": "string",
"fk_mm_child_column_id": "string",
"fk_mm_parent_column_id": "string",
"ur": "string",
"dr": "string",
"fk_index_name": "string",
"deleted": "string",
"order": "string"
"filters": [
"logical_op": "string",
"comparison_op": "string",
"value": "string",
"is_group": true,
"children": [
{}
"sort": [
"direction": "string",
"order": 0
"operationId": "db-table-update",
"table_name": {
"project_id": {
"operationId": "db-table-delete",
"/api/v1/db/meta/tables/{tableId}/reorder": {
"operationId": "db-table-reorder",
"order": {
"/api/v1/db/meta/tables/{tableId}/columns": {
"summary": "Column create",
"operationId": "db-table-column-create",
"$ref": "#/components/schemas/ColumnReq"
"DB table column"
"/api/v1/db/meta/columns/{columnId}": {
"name": "columnId",
"summary": "Column Update",
"operationId": "db-table-column-update",
"$ref": "#/components/schemas/Column"
"operationId": "db-table-column-delete",
"/api/v1/db/meta/columns/{columnId}/primary": {
"operationId": "db-table-column-primary-column-set",
"/api/v1/db/meta/tables/{tableId}/views": {
"operationId": "db-view-list",
"$ref": "#/components/responses/ViewList"
"DB view"
"/api/v1/db/meta/views/{viewId}": {
"name": "viewId",
"operationId": "db-view-update",
"title": {
"show_system_fields": {
"lock_type": {
"enum": [
"collaborative",
"locked",
"personal"
"operationId": "db-view-delete",
"/api/v1/db/meta/views/{viewId}/show-all": {
"operationId": "db-view-show-all-column",
"type": "array"
"name": "ignoreIds"
"/api/v1/db/meta/views/{viewId}/hide-all": {
"operationId": "db-view-hide-all-column",
"/api/v1/db/meta/tables/{tableId}/share": {
"summary": "Shared view list",
"operationId": "db-view-share-list",
"DB view share"
"/api/v1/db/meta/views/{viewId}/share": {
"operationId": "db-view-share-create",
"operationId": "db-view-share-update",
"$ref": "#/components/schemas/SharedView"
"meta": {}
"operationId": "db-view-share-delete",
"/api/v1/db/meta/views/{viewId}/columns": {
"operationId": "db-view-column-list",
"responses": {},
"DB view column"
"operationId": "db-view-column-create",
"/api/v1/db/meta/views/{viewId}/columns/{columnId}": {
"operationId": "db-view-column-update",
"/api/v1/db/meta/views/{viewId}/sorts": {
"operationId": "db-table-sort-list",
"sorts": {
"$ref": "#/components/schemas/Sort"
"DB table sort"
"operationId": "db-table-sort-create",
"/api/v1/db/meta/sorts/{sortId}": {
"name": "sortId",
"operationId": "db-table-sort-get",
"operationId": "db-table-sort-update",
"operationId": "db-table-sort-delete",
"/api/v1/db/meta/views/{viewId}/filters": {
"operationId": "db-table-filter-read",
"$ref": "#/components/schemas/Filter"
"DB table filter"
"operationId": "db-table-filter-create",
"/api/v1/db/meta/hooks/{hookId}/filters": {
"name": "hookId",
"operationId": "db-table-webhook-filter-read",
"$ref": "#/components/responses/FilterList"
"DB table webhook filter"
"operationId": "db-table-webhook-filter-create",
"/api/v1/db/meta/filters/{filterId}": {
"name": "filterId",
"operationId": "db-table-filter-get",
"operationId": "db-table-filter-update",
"operationId": "db-table-filter-delete",
"/api/v1/db/meta/filters/{filterGroupId}/children": {
"name": "filterGroupId",
"operationId": "db-table-filter-children-read",
"/api/v1/db/meta/tables/{tableId}/grids": {
"operationId": "db-view-grid-create",
"$ref": "#/components/schemas/Grid"
"/api/v1/db/meta/tables/{tableId}/forms": {
"operationId": "db-view-form-create",
"$ref": "#/components/schemas/Form"
"/api/v1/db/meta/forms/{formId}": {
"name": "formId",
"operationId": "db-view-form-update",
"operationId": "db-view-form-read",
"/api/v1/db/meta/form-columns/{formViewColumnId}": {
"name": "formViewColumnId",
"operationId": "db-view-form-column-update",
"$ref": ""
"$ref": "#/components/schemas/FormColumn"
"/api/v1/db/meta/grids/{gridId}/grid-columns": {
"name": "gridId",
"operationId": "db-view-grid-columns-list",
"$ref": "#/components/schemas/GridColumn"
"/api/v1/db/meta/grid-columns/{columnId}": {
"operationId": "db-view-grid-column-update",
"/api/v1/db/meta/tables/{tableId}/galleries": {
"operationId": "db-view-gallery-create",
"$ref": "#/components/schemas/Gallery"
"/api/v1/db/meta/galleries/{galleryId}": {
"name": "galleryId",
"operationId": "db-view-gallery-update",
"operationId": "db-view-gallery-read",
"/api/v1/db/meta/projects/{projectId}/meta-diff": {
"operationId": "project-meta-diff-sync",
"operationId": "project-meta-diff-get",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}": {
"name": "orgs",
"name": "projectName",
"name": "tableName",
"summary": "Table row list",
"operationId": "db-table-row-list",
"DB table row"
"name": "fields"
"name": "where"
"summary": "Table row create",
"operationId": "db-table-row-create",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/find-one": {
"summary": "Table row FindOne",
"operationId": "db-table-row-find-one",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/groupby": {
"name": "column_name",
"description": "Column name of the column you want to group by, eg. `column_name=column1`"
"summary": "Table row Group by",
"operationId": "db-table-row-group-by",
"name": "limit"
"name": "offset"
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}": {
"name": "viewName",
"summary": "Table view row list",
"operationId": "db-view-row-list",
"DB view row"
"schema": {},
"name": "nested",
"description": "Query params for nested data"
"summary": "Table view row create",
"operationId": "db-view-row-create",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/find-one": {
"summary": "Table view row FindOne",
"operationId": "db-view-row-find-one",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/groupby": {
"summary": "Table view row Group by",
"operationId": "db-view-row-group-by",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count": {
"summary": "Table view rows count",
"operationId": "db-view-row-count",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}": {
"name": "rowId",
"summary": "Table view row read",
"operationId": "db-view-row-read",
"description": "Created",
"summary": "Table view row update",
"operationId": "db-view-row-update",
"summary": "Table view row delete",
"operationId": "db-view-row-delete",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist": {
"summary": "Table view row exist",
"operationId": "db-view-row-exist",
"description": "check row with provided primary key exists or not",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}": {
"summary": "Table row read",
"operationId": "db-table-row-read",
"summary": "Table row update",
"operationId": "db-table-row-update",
"summary": "Table row delete",
"operationId": "db-table-row-delete",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/exist": {
"summary": "Table row exist",
"operationId": "db-table-row-exist",
"/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}": {
"summary": "Bulk insert table rows",
"operationId": "db-table-row-bulk-create",
"summary": "Bulk update all table rows by IDs",
"operationId": "db-table-row-bulk-update",
"summary": "Bulk delete all table rows by IDs",
"operationId": "db-table-row-bulk-delete",
"/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all": {
"summary": "Bulk update all table rows with conditions",
"operationId": "db-table-row-bulk-update-all",
"summary": "Bulk delete all table rows with conditions",
"operationId": "db-table-row-bulk-delete-all",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/export/{type}": {
"csv",
"excel"
"name": "type",
"summary": "Table view rows export",
"operationId": "db-view-row-export",
"description": "CSV or Excel export",
"wrapped": true,
"application/octet-stream": {
"headers": {
"nc-export-offset": {
"type": "integer"
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/export/{type}": {
"summary": "Tablerows export",
"operationId": "db-table-row-csv-export",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}": {
"mm",
"hm"
"name": "relationType",
"name": "columnName",
"summary": "Nested relations row list",
"operationId": "db-table-row-nested-list",
"type": [
"string",
"number"
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/{refRowId}": {
"name": "refRowId",
"summary": "Nested relations row add",
"operationId": "db-table-row-nested-add",
"summary": "Nested relations row remove",
"operationId": "db-table-row-nested-remove",
"/api/v1/db/data/{orgs}/{projectName}/{tableName}/{rowId}/{relationType}/{columnName}/exclude": {
"summary": "Referenced tables rows excluding current records children/parent",
"operationId": "db-table-row-nested-children-excluded-list",
"/api/v1/db/public/shared-view/{sharedViewUuid}/rows": {
"name": "sharedViewUuid",
"name": "xc-password",
"description": "Shared view password"
"operationId": "public-data-list",
"Public"
"operationId": "public-data-create",
"multipart/form-data": {
"in": "header"
"/api/v1/db/public/shared-view/{sharedViewUuid}/rows/{rowId}/{relationType}/{columnName}": {
"operationId": "public-data-nested-list",
"/api/v1/db/public/shared-view/{sharedViewUuid}/rows/export/{type}": {
"operationId": "public-csv-export",
"/api/v1/db/public/shared-view/{sharedViewUuid}/nested/{columnName}": {
"operationId": "public-data-relation-list",
"/api/v1/db/public/shared-base/{sharedBaseUuid}/meta": {
"name": "sharedBaseUuid",
"operationId": "public-shared-base-get",
"/api/v1/db/public/shared-view/{sharedViewUuid}/meta": {
"operationId": "public-shared-view-meta-get",
"$ref": "#/components/schemas/View"
"relatedMetas": {},
"client": {
"columns": {
"oneOf": [
"$ref": "#/components/schemas/GalleryColumn"
"model": {
"view": {
"application/xml": {
"/api/v1/db/meta/audits/comments": {
"operationId": "utils-comment-list",
"name": "row_id",
"name": "fk_model_id",
"name": "comments_only"
"Utils"
"operationId": "utils-comment-row",
"row_id": {
"fk_model_id": {
"description": {
"row_id",
"fk_model_id",
"comment"
"/api/v1/db/meta/audits/comments/count": {
"operationId": "utils-comment-count",
"name": "ids",
"/api/v1/db/meta/projects/{projectId}/audits": {
"operationId": "project-audit-list",
"$ref": "#/components/schemas/Audit"
"/api/v1/db/meta/audits/rows/{rowId}/update": {
"operationId": "utils-audit-row-update",
"column_name": {
"prev_value": {
"/api/v1/db/meta/tables/{tableId}/hooks": {
"operationId": "db-table-webhook-list",
"$ref": "#/components/schemas/Hook"
"DB table webhook"
"operationId": "db-table-webhook-create",
"/api/v1/db/meta/tables/{tableId}/hooks/test": {
"operationId": "db-table-webhook-test",
"payload": {
"data": {},
"user": {}
"hook": {
"/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}": {
"update",
"delete",
"insert"
"name": "operation",
"operationId": "db-table-webhook-sample-payload-get",
"plugins": {
"$ref": "#/components/schemas/Plugin"
"/api/v1/db/meta/hooks/{hookId}": {
"operationId": "db-table-webhook-update",
"operationId": "db-table-webhook-delete",
"/api/v1/db/meta/plugins": {
"operationId": "plugin-list",
"Plugin"
"/api/v1/db/meta/plugins/{pluginTitle}/status": {
"name": "pluginTitle",
"operationId": "plugin-status",
"description": "Check plugin is active or not",
"/api/v1/db/meta/plugins/test": {
"operationId": "plugin-test",
"description": "Bad Request"
"id": {
"input": {},
"category": {
"/api/v1/db/meta/plugins/{pluginId}": {
"name": "pluginId",
"operationId": "plugin-update",
"operationId": "plugin-read",
"/api/v1/db/meta/connection/test": {
"operationId": "utils-test-connection",
"code": {
"message": {
"/api/v1/db/meta/nocodb/info": {
"operationId": "utils-app-info",
"/api/v1/db/meta/axiosRequestMake": {
"operationId": "utils-axios-request-make",
"description": "Generic Axios Call",
"type": "object"
"/api/v1/version": {
"operationId": "utils-app-version",
"/api/v1/health": {
"operationId": "utils-app-health",
"/api/v1/db/meta/cache": {
"summary": "Your GET endpoint",
"operationId": "utils-cache-get",
"description": "Get All K/V pairs in NocoCache"
"operationId": "utils-cache-delete",
"description": "Delete All K/V pairs in NocoCache",
"/api/v1/db/meta/projects/{projectId}/api-tokens": {
"Api token"
"$ref": "#/components/schemas/ApiToken"
"operationId": "api-token-list"
"operationId": "api-token-create",
"/api/v1/db/meta/projects/{projectId}/api-tokens/{token}": {
"operationId": "api-token-delete",
"/api/v1/db/storage/upload": {
"summary": "Attachment",
"operationId": "storage-upload",
"Storage"
"files": {},
"json": {
"name": "path",
"/api/v1/db/storage/upload-by-url": {
"operationId": "storage-upload-by-url",
"fileName": {
"mimetype": {
"size": {
"/api/v1/db/meta/projects/{projectId}/users/{userId}/resend-invite": {
"operationId": "auth-project-user-resend-invite",
"description": "Resend Invitation to a specific user",
"components": {
"schemas": {
"User": {
"title": "User",
"examples": [
"id": "142",
"firstName": "Alice",
"lastName": "Smith",
"email": "alice.smith@gmail.com",
"dateOfBirth": "1997-10-31",
"emailVerified": true,
"signUpDate": "2019-08-24"
"x-internal": false,
"description": "Unique identifier for the given user."
"firstname": {
"lastname": {
"format": "email"
"date_of_birth": {
"format": "date",
"example": "1997-10-31"
"email_verified": {
"description": "Set to true if the user's email has been verified."
"createDate": {
"description": "The date that the user was created."
"id",
"firstname",
"lastname",
"email_verified"
"PageReqQueryParams": {
"title": "PageReqQueryParams",
"offset": {
"limit": {
"query": {
"UserList": {
"x-examples": {
"bases": {
"list": [
"project_id": "string",
"host": "string",
"port": 0,
"username": "string",
"password": "string",
"database": "string",
"url": "string",
"params": "string",
"ssl": "string"
"pageSize": 0,
"totalRows": 0,
"sort": "string",
"isFirstPage": true,
"isLastPage": true
"users"
"ProjectReq": {
"title": "Project",
"color": {
"$ref": "#/components/schemas/BaseReq"
"Project": {
"status": {
"meta": {
"object"
"deleted": {
"boolean"
"$ref": "#/components/schemas/Base"
"is_meta": {
"prefix": {
"created_at": {},
"updated_at": {},
"slug": {
"ProjectList": {
"": {
"Base": {
"title": "Base",
"alias": {
"type": {
"readOnly": true
"config": {},
"inflection_column": {
"inflection_table": {
"BaseReq": {
"BaseList": {
"bases"
"Table": {
"title": "Table",
"enabled": true,
"primary_key": true,
"primary_value": true,
"auto_increment": true,
"unique": true,
"columnByIds": {}
"fk_project_id": {
"fk_base_id": {
"enabled": {
"parent_id": {
"show_as": {
"tags": {
"pinned": {
"columnsById": {
"table_name",
"title"
"View": {
"TableInfo": {
"column": {
"filters": {
"sort": {
"title",
"table_name"
"TableReq": {
"mm": {
"columns"
"TableList": {
"tables"
"Filter": {
"title": "Filter",
"fk_column_id": {
"logical_op": {
"comparison_op": {
"number",
"integer",
"boolean",
"null"
"is_group": {
"children": {
"base_id": {
"fk_parent_id": {
"fk_view_id": {
"fk_hook_id": {
"FilterList": {
"list"
"filters"
"Sort": {
"title": "Sort",
"direction": {
"SortList": {
"sorts"
"Column": {
"title": "Column",
"uidt": {
"dt": {
"np": {
"ns": {
"clen": {
"integer"
"cop": {
"pk": {
"pv": {
"rqd": {
"un": {
"ct": {
"ai": {
"unique": {
"cdf": {
"cc": {
"csn": {
"dtx": {
"dtxp": {
"dtxs": {
"au": {
"visible": {
"system": {
"meta": {},
"$ref": "#/components/schemas/LinkToAnotherRecord"
"$ref": "#/components/schemas/Formula"
"$ref": "#/components/schemas/Rollup"
"$ref": "#/components/schemas/Lookup"
"$ref": "#/components/schemas/SelectOptions"
"uidt"
"ColumnList": {
"LinkToAnotherRecord": {
"title": "LinkToAnotherRecord",
"virtual": {
"fk_child_column_id": {
"fk_parent_column_id": {
"fk_mm_model_id": {
"fk_related_model_id": {
"fk_mm_child_column_id": {
"fk_mm_parent_column_id": {
"ur": {
"dr": {
"fk_index_name": {
"Lookup": {
"title": "Lookup",
"fk_relation_column_id": {
"fk_lookup_column_id": {
"Rollup": {
"title": "Rollup",
"fk_rollup_column_id": {
"rollup_function": {
"Formula": {
"title": "Formula",
"formula": {
"formula_raw": {
"SelectOptions": {
"title": "SelectOptions",
"options": {
"required": true,
"$ref": "#/components/schemas/SelectOption"
"options": [
"color": "string",
"order": 1
"SelectOption": {
"title": "SelectOption",
"Grid": {
"title": "Grid",
"Gallery": {
"title": "Gallery",
"next_enabled": {
"prev_enabled": {
"cover_image_idx": {
"cover_image": {
"restrict_types": {
"restrict_size": {
"restrict_number": {
"fk_cover_image_col_id": {
"GalleryColumn": {
"title": "GalleryColumn",
"label": {
"help": {
"fk_col_id": {
"fk_gallery_id": {
"GridColumn": {
"width": {
"KanbanColumn": {
"title": "KanbanColumn",
"fk_kanban_id": {
"Kanban": {
"title": "Kanban",
"public": {
"$ref": "#/components/schemas/KanbanColumn"
"Form": {
"title": "Form",
"heading": {
"subheading": {
"success_msg": {
"redirect_url": {
"redirect_after_secs": {
"banner_image_url": {
"logo_url": {
"submit_another_form": {
"show_blank_form": {
"FormColumn": {
"_cn": "first_name",
"alias": "first_name",
"fk_column_id": "cl_yvyhsl9u81tokc",
"id": "fvc_8z1i7t8aswkqxx",
"fk_view_id": "vw_s1pf4umdnikoyn",
"uuid": null,
"label": "dsdsds",
"help": null,
"required": false,
"show": 1,
"order": 1,
"created_at": "2022-02-15 12:39:04",
"updated_at": "2022-02-15 12:39:16",
"description": "dsdsdsdsd"
"minLength": 1
"uuid": {},
"help": {},
"required": {
"show": {
"created_at": {
"updated_at": {
"Paginated": {
"title": "Paginated",
"pageSize": {
"totalRows": {
"array"
"isFirstPage": {
"isLastPage": {
"page": {
"HookList": {
"SharedView": {
"title": "SharedView",
"SharedViewList": {
"ViewList": {
"views"
"title": ""
"Attachment": {
"title": "Attachment",
"icon": {
"Webhook": {
"title": "Webhook",
"Audit": {
"title": "AuditType",
"user": {
"ip": {
"op_type": {
"op_sub_type": {
"details": {
"Hook": {
"env": {
"event": {
"After",
"Before"
"operation": {
"insert",
"update"
"async": {
"condition": {
"notification": {
"retries": {
"retry_interval": {
"timeout": {
"active": {
"Plugin": {
"title": "Plugin",
"rating": {
"version": {
"docs": {
"status_details": {
"logo": {
"input_schema": {
"input": {
"creator": {
"creator_website": {
"price": {
"ModelRoleVisibility": {
"title": "ModelRoleVisibility",
"role": {
"disabled": {
"ApiToken": {
"title": "ApiToken",
"HookLog": {
"test_call": {
"conditions": {
"notifications": {
"error_code": {
"error_message": {
"error": {
"execution_time": {
"response": {
"triggered_by": {
"ColumnReq": {
"ID",
"SingleLineText",
"LongText",
"Attachment",
"Checkbox",
"MultiSelect",
"SingleSelect",
"Collaborator",
"Date",
"Year",
"Time",
"PhoneNumber",
"Email",
"URL",
"Number",
"Decimal",
"Currency",
"Percent",
"Duration",
"Rating",
"Count",
"DateTime",
"CreateTime",
"LastModifiedTime",
"AutoNumber",
"Geometry",
"JSON",
"SpecificDBType",
"Barcode",
"Button"
"LinkToAnotherRecord"
"parentId": {
"childId": {
"hm",
"bt",
"mm"
"uidt",
"parentId",
"childId",
"type"
"Rollup"
"Lookup"
"UserInfo": {
"title": "UserInfo",
"roles": {}
"requestBodies": {
"Signup": {
"email": true
"ProjectCreate": {
"anyOf": [
"$ref": "#/components/schemas/ProjectReq"
"status": "string",
"description": "string",
"meta": "string",
"bases": [
"BaseCreate": {
"TableCreate": {
"ColumnCreate": {
"ViewCreate": {
"SortCreate": {
"SharedViewCreate": {
"HookCreate": {
"ProjectUpdate": {
"BaseUpdate": {
"ColumnUpdate": {
"TableUpdate": {
"ViewUpdate": {
"ViewColumnUpdate": {
"SortUpdate": {
"FilterUpdate": {
"FilterCreate": {
"HookUpdate": {
"SharedViewUpdate": {
"description": "Example response",
"$ref": "#/components/schemas/ProjectList"
"projects": {
"is_meta": true,
"config": null,
"created_at": null,
"updated_at": null
"prefix": "string",
"isLastPage": true,
"page": 0
"$ref": "#/components/schemas/BaseList"
"$ref": "#/components/schemas/TableList"
"$ref": "#/components/schemas/ColumnList"
"$ref": "#/components/schemas/FilterList"
"$ref": "#/components/schemas/SortList"
"$ref": "#/components/schemas/ViewList"
"views": {
"$ref": "#/components/schemas/SharedViewList"
"$ref": "#/components/schemas/HookList"
"$ref": "#/components/schemas/UserList"
"securitySchemes": {
"xc-auth": {
"name": "API Key",
"type": "apiKey",
"description": "JWT access token"
"xc-shared-base-id": {
"description": "Shared base uuid"