GET
/
table
/
{tableId}
/
record
/
{recordId}
curl --request GET \
  --url 'https://app.teable.io/api/table/%7BtableId%7D/record/%7BrecordId%7D?projection=SOME_ARRAY_VALUE&cellFormat=SOME_STRING_VALUE&fieldKeyType=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "id": "<string>",
  "name": "<string>",
  "fields": {},
  "autoNumber": 123,
  "createdTime": "<string>",
  "lastModifiedTime": "<string>",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required
​
recordId
string
required

Query Parameters

​
projection
string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

​
cellFormat
enum<string>
default:
json

Define the return value formate, you can set it to text if you only need simple string value

Available options:
json,
text
​
fieldKeyType
enum<string>
default:
name

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

Available options:
id,
name

Response

200 - application/json
Success
​
id
string
required

The record id.

​
fields
object
required

Objects with a fields key mapping fieldId or field name to value for that field.

​
name
string

primary field value

​
autoNumber
number

Auto number, a unique identifier for each record

​
createdTime
string

Created time, date ISO string (new Date().toISOString).

​
lastModifiedTime
string

Last modified time, date ISO string (new Date().toISOString).

​
createdBy
string

Created by, user name

​
lastModifiedBy
string

Last modified by, user name

Previous
Duplicate record
Next