Get record index

viewIdstring

Set the view you want to fetch, default is first view. result will filter and sort by view options.

Example:viwXXXXXXX

Set the view you want to fetch, default is first view. result will filter and sort by view options.

string

OR

boolean

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

filterByTqlstring

Example:{field} = 'Completed' AND {field} > 5

filterstring

A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters.

string[]

OR

string[]

OR

Search for records that match the specified field and value

string[]

OR

string

Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear.

string[]

OR

string

Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field

selectedRecordIdsstring[]

Filter selected records by record ids

orderBystring

An array of sort objects that specifies how the records should be ordered.

groupBystring

An array of group objects that specifies how the records should be grouped.

collapsedGroupIdsstring

An array of group ids that specifies which groups are collapsed

queryIdstring

When provided, other query parameters will be merged with the saved ones.

Example:qry_xxxxxxxx

When provided, other query parameters will be merged with the saved ones.

recordIdstring required

v1

Path parameters

Query parameters

Response