Skip to main content
GET
cURL

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

tableId
string
必須

クエリパラメータ

viewId
string

Set the view you want to fetch. When provided, records will follow that view's filter and sort settings. When omitted, the API queries the table without applying a view.

:

"viwXXXXXXX"

ignoreViewQuery

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

filterByTql
string
非推奨
:

"{field} = 'Completed' AND {field} > 5"

filter
string

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.

search

Search for records that match the specified field and value

Required array length: 1 element
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.

Required array length: 2 elements
:
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

Required array length: 2 elements
:
selectedRecordIds
string[]

Filter selected records by record ids

groupBy
string

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

field
object
orderBy
string

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

collapsedGroupIds
string

An array of group ids that specifies which groups are collapsed

skip
integer | null
デフォルト:0
必須範囲: x >= 0
take
integer
必須
必須範囲: x >= 1

レスポンス

200 - application/json

Aggregation result for the selected row range

aggregations
object[]
最終更新日 2026年9月15日