Get Records
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
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.
Specifies the number of records to retrieve, maximum value is 1000.
Specifies the number of records to skip, used for pagination.
Defines the key type for fields in records, possible values:
name: Use field names as keys (default)id: Use field IDs as keysdbFieldName: Use field dbFieldName as keys
Defines the return format for cell values, possible values:
json: Returns structured JSON data (default)text: Returns plain text format
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).
Array of sort objects specifying how records should be ordered.
Complex query condition object for filtering results. Supports complex query conditions based on fields, operators, and values.
Search for records matching specified fields and values.
Advanced Query Parameters
Advanced Query Parameters
Array of group objects specifying how records should be grouped.
Array of group IDs to collapse.
Filter selected records by record IDs.
When viewId is specified, setting this to true will ignore the view’s filters, sorting, and other settings.
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.
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.