Actions
List Records

Params

keyrequired
string

A unique string. Please see the Keys and Resumability doc for more info.

paramsrequired
object

List Records Input

baseIdrequired
string

The ID of the base

tableIdOrNamerequired
string

The name or id of the table

timeZone
string

The time zone that should be used to format dates when using string as the cellFormat. This parameter is required when using string as the cellFormat

userLocal
string

The user locale that should be used to format dates when using string as the cellFormat. This parameter is required when using string as the cellFormat.

pageSize
number

The number of records returned in each request. Must be less than or equal to 100. Default is 100.

maxRecords
number

The maximum total number of records that will be returned in your requests. If this value is larger than pageSize (which is 100 by default), you may have to load multiple pages to reach this total.

offset
string

To fetch the next page of records, include offset from the previous request in the next request’s parameters.

view
string

The name or ID of a view in the table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the sort parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the fields parameter.

sort
array

Sort

filterByFormula
string

A formula used to filter records. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error! the record will be included in the response. If combined with the view parameter, only records in that view which satisfy the formula will be returned. For example, to only include records where the column named “Category” equals “Programming”, pass in: filterByFormula==“Programming”

fields
array

Only data for fields whose names or IDs are in this list will be included in the result. If you don’t need every field, you can use this parameter to reduce the amount of data transferred.

Response

object

List Records Output