provider Records GET /{baseId}/{tableIdOrName}
@utdk/airtable /{baseId}/{tableIdOrName}
List records
Returns a list of records in a specified table. Records are returned in the order they appear in the table view. You can filter, sort, and paginate the results using query parameters.
baseId path required
The Airtable base ID (starts with 'app')
string
tableIdOrName path required
The table ID (starts with 'tbl') or table name
string
fields[] query
Field names to include in the response. If not specified, all fields are returned.
array
filterByFormula query
An Airtable formula to filter records (e.g. '{Status}="Done"')
string
maxRecords query
Maximum number of records to return (max 100)
integer
pageSize query
Number of records per page (default 100, max 100)
integer
offset query
Pagination offset string returned from a previous request
string
view query
Name or ID of a view to filter and sort records
string
sort[0][field] query
Field name to sort by
string
sort[0][direction] query
Sort direction
enum: asc, desc

Try it

Authentication
Configure credentials for Airtable REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

listrecords
GET/{baseId}/{tableIdOrName}
Returns a list of records in a specified table. Records are returned in the order they appear in the table view. You can filter, sort, and paginate the results using query parameters.

Parameters

required

The Airtable base ID (starts with 'app')

required

The table ID (starts with 'tbl') or table name

Field names to include in the response. If not specified, all fields are returned.

An Airtable formula to filter records (e.g. '{Status}="Done"')

Maximum number of records to return (max 100)

Number of records per page (default 100, max 100)

Pagination offset string returned from a previous request

Name or ID of a view to filter and sort records

Field name to sort by

Sort direction

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import airtable from '@utdk/airtable';

await airtable.listrecords({
  "pageSize": 100
})