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

Teable Field API

Columns within a table.

Teable Field API is one of 7 APIs that Teable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://app.teable.io/api, https://app.teable.ai/api.

6 operations 3 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.teable.io/api
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Teable Field API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Personal access token or OAuth access token passed as Authorization: Bearer {accesstoken}.

Paths & Operations 6

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

Field 6

Columns within a table.

GET
/table/{tableId}/field
List fields
getFieldList 1 param → 200
POST
/table/{tableId}/field
Create a field
createField 1 param body → 201
GET
/table/{tableId}/field/{fieldId}
Get a field
getField 2 params → 200
PATCH
/table/{tableId}/field/{fieldId}
Update a field
updateField 2 params body → 200
DELETE
/table/{tableId}/field/{fieldId}
Delete a field
deleteField 2 params → 200
PUT
/table/{tableId}/field/{fieldId}/convert
Convert a field type
convertField 2 params body → 200

Schemas 3

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

Field
object
6 properties
UpdateFieldRequest
object
2 properties
CreateFieldRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teable-field-api-openapi.yml Raw ↑

Other APIs Teable publishes across the network.

Teable Attachment API
Teable Base API
Teable Record API
Teable Space API
Teable Table API
Teable View API