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 Record API

Rows within a table.

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

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

This API exposes 6 operations across 2 paths, and defines 5 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 2 paths 5 schemas 2 DELETE2 GET1 PATCH1 POST

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 Record 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 2 paths, the API surfaces 6 operations — 2 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Record 6

Rows within a table.

GET
/table/{tableId}/record
List records
getRecords 11 params → 200401
POST
/table/{tableId}/record
Create records
createRecords 1 param body → 201
DELETE
/table/{tableId}/record
Delete multiple records
deleteRecords 2 params → 200
GET
/table/{tableId}/record/{recordId}
Get a record
getRecord 4 params → 200404
PATCH
/table/{tableId}/record/{recordId}
Update a record
updateRecord 2 params body → 200
DELETE
/table/{tableId}/record/{recordId}
Delete a record
deleteRecord 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Record (4 properties), Error (3 properties), UpdateRecordRequest (3 properties), CreateRecordsRequest (3 properties). Each schema is shown below with its type and property counts.

CreateRecordsRequest
object
3 properties 1 required
RecordListResponse
object
1 property
UpdateRecordRequest
object
3 properties 1 required
Error
object
3 properties
Record
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teable-record-api-openapi.yml Raw ↑

Other APIs Teable publishes across the network.

Teable Attachment API
Teable Base API
Teable Field API
Teable Space API
Teable Table API
Teable View API