Skip to main content

airtable.getrecordprops

Home > @runlightyear/airtable > GetRecordProps

GetRecordProps interface

Signature:
interface GetRecordProps 

Required Properties

PropertyModifiersTypeDescription
baseIdstring
recordIdstring
tableIdOrNamestring

Optional Properties

PropertyModifiersTypeDescription
cellFormat?"json" | "string"

The format that should be used for cell values. Supported values are:

json: cells will be formatted as JSON, depending on the field type. string: cells will be formatted as user-facing strings, regardless of the field type. The timeZone and userLocale parameters are required when using string as the cellFormat.

Note: You should not rely on the format of these strings, as it is subject to change.

The default is json.

returnFieldsByFieldId?boolean

An optional boolean value that lets you return field objects where the key is the field id.

This defaults to false, which returns field objects where the key is the field name.