For the complete documentation index, see llms.txt. This page is also available as Markdown.

Records

This API allows users to create, retrieve, and manage records that are fully customizable and dynamically configured in the dashboard. Records can store various types of structured data, enabling flexible integrations and workflows tailored to specific business needs.

Create a new record in a table

post

Create a new record in a table. Requires can_edit_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table to create the record in

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
datestring · nullableOptional

Date field

idFieldstring · nullableOptional

Identifier field in UUID format

numbernumber · nullableOptional

Number field

datetimestring · nullableOptional

DateTime field

checkboxboolean · nullableOptional

Boolean field

jsonobject · nullableOptional

JSON field with arbitrary data

assigneestring · nullableOptional

Assigned user ID

textstring · nullableOptional

Text field

integernumber · nullableOptional

Integer field

singleSelectstring · nullableOptional

Select field option

Responses
201

201

application/json;charset=UTF-8
post/tables/{tableId}/records

Get a record by ID

get

Get a record by ID. Requires can_read_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to retrieve

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Responses
200

200

application/json;charset=UTF-8
get/tables/{tableId}/records/{id}

Search records in a table

post

Search records in a table. Requires can_read_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table to search records in

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
viewstring · nullableOptional

Optional view ID to filter records

pageNumbernumberRequired

Page number (0-based)

pageSizenumberRequired

Number of records per page

Responses
200

200

application/json;charset=UTF-8
post/tables/{tableId}/records/search

Delete a record by ID

delete

Delete a record by ID. Requires can_edit_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to delete

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Responses
204

204

No content

delete/tables/{tableId}/records/{id}

No content

Delete multiple records in batch

post

Delete multiple records in batch. Requires can_edit_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table containing the records

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Bodyone of[]

Array of record IDs to delete

objectOptional
or
booleanOptional
or
stringOptional
or
numberOptional
Responses
204

204

No content

post/tables/{tableId}/records/delete-batch

No content

Update an existing record by ID

patch

Update an existing record by ID. Requires can_edit_data permission on the table.

Authorizations
AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters
tableIdstringRequired

Identifier of the table containing the record

idstringRequired

Identifier of the record to update

Header parameters
Content-TypestringRequired

Content type of the response

Example: application/json;charset=UTF-8
AuthorizationstringRequired

Organization token (tot_) — preferred method, or legacy Bearer JWT token. Pass the tot_ token directly without Bearer prefix; use Bearer <jwt> for legacy JWT auth.

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjY0Y2IwZmY5LTk1NzUtNDg5OS05ZmYwLTI2MWE2ZGE3NjM3ZSIsICJpYXQiOjE3NTY3Mzc1OTcsICJleHAiOjE3NTY3NDExOTcsICJjdXN0b206dGVhbUlkIjoiMTgyY2Q2ZDItNDAyMS00NDY2LTkyYTAtN2JlMmVjYWY3OGJhIn0.
Body
datestring · nullableOptional

Date field

idFieldstring · nullableOptional

Identifier field in UUID format

numbernumber · nullableOptional

Number field

datetimestring · nullableOptional

DateTime field

checkboxboolean · nullableOptional

Boolean field

jsonobject · nullableOptional

JSON field with arbitrary data

assigneestring · nullableOptional

Assigned user ID

textstring · nullableOptional

Text field

integernumber · nullableOptional

Integer field

singleSelectstring · nullableOptional

Select field option

Responses
200

200

application/json;charset=UTF-8
patch/tables/{tableId}/records/{id}
Attachments

Last updated