We provide developers with a built-in Query Parameter Builder that can help construct custom requests based on your existing tables.

​
Path

GET /api/table/{tableId}/record ​

​
Request

​
Path Parameters

tableId (string): The unique identifier of the table (how to get).

​
Basic Query Parameters

All parameters are optional
​
viewId
string
Specifies the view ID to fetch records from. If not specified, records will be returned in order of creation time, including all records and fields.
​
take
number
Specifies the number of records to retrieve, maximum value is 1000.
​
skip
number
Specifies the number of records to skip, used for pagination.
​
fieldKeyType
string
default:"name"
Defines the key type for fields in records, possible values:
  • name: Use field names as keys (default)
  • id: Use field IDs as keys
  • dbFieldName: Use field dbFieldName as keys
​
cellFormat
string
default:"json"
Defines the return format for cell values, possible values:
  • json: Returns structured JSON data (default)
  • text: Returns plain text format
​
projection
string[]
If you only need specific fields, specify them through this parameter. Otherwise, all visible fields will be retrieved. Parameter values depend on fieldKeyType setting (using field names or IDs or dbFieldName).
​
orderBy
string
Array of sort objects specifying how records should be ordered.
​
filter
string
Complex query condition object for filtering results. Supports complex query conditions based on fields, operators, and values.
​
search
string[]
Search for records matching specified fields and values.
​
groupBy
string
Array of group objects specifying how records should be grouped.
​
collapsedGroupIds
string[]
Array of group IDs to collapse.
​
selectedRecordIds
string[]
Filter selected records by record IDs.
​
ignoreViewQuery
boolean
When viewId is specified, setting this to true will ignore the view’s filters, sorting, and other settings.
​
filterLinkCellCandidate
string[]
Filter records from the linked table that can be selected by the specified link cell. For example, for one-to-many or one-to-one relationship fields, already selected record IDs will not appear.
​
filterLinkCellSelected
string[]
Filter records from the linked table that are already selected by this link cell. Note: viewId, filter, and orderBy will not take effect in this case, as selected records have their own order.