Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NocoDB Fields API

Field/column management operations

NocoDB Fields API is one of 9 APIs that NocoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fields. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://app.nocodb.com.

4 operations 2 paths 2 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://app.nocodb.com/api/v3
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

NocoDB Fields API declares 2 security schemes for authenticating requests. An API key is passed in the header as xc-token (xcToken). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • xcToken — NocoDB API token
  • bearerAuth — Bearer token authentication. Use 'Authorization: Bearer ' header format.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Fields 4

Field/column management operations

GET
/api/v1/meta/tables/{tableId}/fields
List fields
field-list 1 param → 200400
POST
/api/v1/meta/tables/{tableId}/fields
Create field
field-create 1 param body → 200400
PATCH
/api/v1/meta/fields/{fieldId}
Update field
field-update 1 param body → 200400
DELETE
/api/v1/meta/fields/{fieldId}
Delete field
field-delete 1 param → 200400

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Field (12 properties), FieldReq (5 properties). Each schema is shown below with its type and property counts.

Field
object
12 properties
FieldReq
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nocodb-fields-api-openapi.yml Raw ↑

Other APIs NocoDB publishes across the network.

NocoDB Attachments API
NocoDB Auth API
NocoDB Bases API
NocoDB Hooks API
NocoDB Links API
NocoDB Records API
NocoDB Tables API
NocoDB Views API