GET
/
table
/
{tableId}
/
aggregation
/
search-index
curl --request GET \
  --url 'https://app.teable.io/api/table/%7BtableId%7D/aggregation/search-index?viewId=viwXXXXXXX&ignoreViewQuery=SOME_STRING_VALUE&filterByTql=%7Bfield%7D+%3D+%27Completed%27+AND+%7Bfield%7D+%3E+5&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&filterLinkCellCandidate=fldXXXXXXX&filterLinkCellCandidate=recXXXXXXX&filterLinkCellSelected=fldXXXXXXX&filterLinkCellSelected=recXXXXXXX&selectedRecordIds=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
[
  {
    "index": 123,
    "fieldId": "<string>",
    "recordId": "<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

Query Parameters

​
viewId
string

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

​
ignoreViewQuery

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

​
filterByTql
string
deprecated
​
filter
string

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

​
search

Search for records that match the specified field and value

​
filterLinkCellCandidate

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.

​
filterLinkCellSelected

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

​
selectedRecordIds
string[]

Filter selected records by record ids

Response

200 - application/json
record index with search query
​
index
number
required
​
fieldId
string
required
​
recordId
string
required
Previous
Create table
Next