Skip to main content

List Records

Retrieves records from a specified Airtable table with optional filtering and view selection.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Key Id - The key identifier returned from the Connect node.
  • Base Id - The unique identifier of the Airtable base where the records exist.
  • Table Name - The name of the table from which to retrieve records.

Options​

  • View Name - (Optional) The name of a specific view to retrieve records from.
  • Query - (Optional) Additional query parameters for filtering, sorting, or limiting results.

Output​

  • result - An object containing the retrieved records and metadata.

How It Works​

The List Records node retrieves multiple records from an Airtable table. When executed, the node:

  1. Validates the required inputs (Base Id and Table Name)
  2. Constructs the Airtable API endpoint URL with optional view and query parameters
  3. Retrieves the API key using the provided Key Id
  4. Sends a GET request to the Airtable API
  5. Returns the retrieved records and metadata as the result

Requirements​

  • A valid Airtable account
  • An Airtable base with appropriate permissions
  • A connected Airtable session (using the Connect node)
  • Valid Base Id and Table Name

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Key Id
  • Empty or invalid Base Id
  • Empty or invalid Table Name
  • Airtable API errors (e.g., table not found, insufficient permissions)
  • HTTP connection errors

Usage Notes​

  • The result includes an array of records and pagination information
  • Records are returned in the order defined by the table or view
  • When using a view, only records visible in that view are returned
  • Query parameters can be used for filtering, sorting, and limiting results
  • The node returns a maximum of 100 records per request (Airtable API limit)
  • For large datasets, use pagination with the offset parameter in the Query option

Query Parameters​

The Query option supports various Airtable API parameters:

  • filterByFormula - Filter records using a formula
  • sort - Sort records by field values
  • maxRecords - Limit the number of records returned
  • pageSize - Set the page size (1-100)
  • offset - For pagination, use the offset value from the previous response
  • fields - Specify which fields to include in the response

Example​

To retrieve all records from a Contacts table:

Inputs:

  • Key Id: (from Connect node)
  • Base Id: "appBase123"
  • Table Name: "Contacts"

Options:

  • View Name: "All Contacts"
  • Query: "maxRecords=50&sort[0][field]=Name&sort[0][direction]=asc"

Output: The result will contain an object with records and metadata:

{
  "records": [
    {
      "id": "rec1",
      "fields": {
        "Name": "John Doe",
        "Email": "john@example.com"
      },
      "createdTime": "2023-01-01T00:00:00Z"
    }
  ],
  "offset": "some_offset_string"
}

Best Practices​

  • Use views to pre-filter records when possible for better performance
  • Implement pagination for large datasets using the offset parameter
  • Limit the fields returned using the fields parameter to reduce response size
  • Handle the offset in the result for retrieving additional pages of data
  • Use appropriate error handling for API rate limits and connection issues