Skip to main content

Retrieve records

Retrieve a list of records from Airtable

Application

  • Airtable

Inputs (what you have)

NameDescriptionData TypeRequired?
Base IDUnique identifier of the base. Example: app1234567890TextYes
Table ID or nameTable ID or table name. Table names and table IDs can be used interchangeably, but table IDs are recommended so requests do not need to change when a table is renamed. Example: tbl1234567890TextYes
View ID or nameName or ID of a view in the table. When set, only records in that view are returned and sorted according to the view order unless sort is specifiedTextNo
Filter formulaFormula used to filter records. Records are included when the evaluated result is not 0, false, an empty string, NaN, an empty array, or an errorTextNo
SortList of sort objects that specify how records are ordered. Each object must include a field name or ID; direction is optional and defaults to ascListNo
Fields to returnNames or IDs of fields to include in the responseListNo
Cell formatFormat used for cell values. The timezone and userLocale parameters are required when using stringTextNo
Return fields by field ID?When enabled, returned field objects are keyed by field ID instead of field nameTrue/FalseNo
Include date dependency metadata?When enabled, linked record fields return objects with an id property instead of record ID stringsTrue/FalseNo
Record metadataOptional metadata to include on each returned record. Include commentCount to return the number of comments on each recordListNo
Time zoneTime zone used to format dates when cell format is set to stringTextNo
User localeUser locale used to format dates when cell format is set to stringTextNo
Page sizeNumber of records returned in each page of results. Must be less than or equal to 100NumberNo
Maximum number of recordsNumberNo
OffsetPagination cursor from a previous response. Include this to fetch the next page of recordsTextNo
FieldName or ID of the field to sort onTextYes
DirectionSort direction. Defaults to ascTextNo

Outputs (what you get)

NameDescriptionData Type
Response status codeThe HTTP status code returned by the API.Number
Response headersThe response headers returned by the API.JSON
Response bodyThe response body returned by the API.JSON

Requirements

  • N/A