Get export

curl --request GET \ --url 'https://app.teable.ai/api/export/%7BtableId%7D?viewId=viwXXXXXXX&ignoreViewQuery=SOME_STRING_VALUE&filter=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&projection=SOME_ARRAY_VALUE&columnMeta=SOME_STRING_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

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.

Example:

"viwXXXXXXX"

ignoreViewQuery

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

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.

orderBy

string

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

groupBy

string

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

projection

string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

columnMeta

string

When ignoreViewQuery is true, use this columnMeta to sort fields by order. Format: { fieldId: { order: number } }

Response

200

Download successful

Getting Started

Records

API Reference

Authorizations

Path Parameters

Query Parameters

Response