TEteable
record

Get record status

Retrieve the visibility and deletion status of a specific record.

get/table/{tableId}/record/{recordId}/status

Request

Path parameters

tableIdstring required
recordIdstring required

Query parameters

projectionstring[]

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

cellFormat'json' | 'text'

Define the return value formate, you can set it to text if you only need simple string value

fieldKeyType'id' | 'name' | 'dbFieldName'

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

viewIdstring

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

Example:viwXXXXXXX
string
OR
boolean
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
string[]
OR
string
string[]
OR
string
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
string
OR
number
string
OR
number

Response

List of records

isVisibleboolean required
isDeletedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.