record
Get record
Retrieve a single record by its ID with options to specify field projections and output format.
get/table/{tableId}/record/{recordId}
Request
- Base URLhttps://app.teable.ai/api
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.