pluginsplugin-airtable

List records from an Airtable table

Retrieve records from an Airtable table with support for filtering, field selection, pagination, and different output formats.

yaml
type: "io.kestra.plugin.airtable.records.list"

List high-priority tasks with filtering

yaml
id: list_airtable_tasks
namespace: company.airtable

tasks:
  - id: get_high_priority_tasks
    type: io.kestra.plugin.airtable.records.List
    baseId: "{{ secret('AIRTABLE_BASE_ID') }}"
    tableId: "Tasks"
    apiKey: "{{ secret('AIRTABLE_PERSONAL_ACCESS_TOKEN') }}"
    filterByFormula: "AND({Status} != 'Done', {Priority} = 'High')"
    fields: ["Task Name", "Status", "Priority", "Due Date"]
    maxRecords: 50
    fetchType: FETCH

List all customers from a view

yaml
id: list_customers
namespace: company.airtable

tasks:
  - id: get_customers
    type: io.kestra.plugin.airtable.records.List
    baseId: "{{ secret('AIRTABLE_BASE_ID') }}"
    tableId: "Customers"
    apiKey: "{{ secret('AIRTABLE_PERSONAL_ACCESS_TOKEN') }}"
    view: "Active Customers"
    fetchType: STORE

List records with auto-pagination

yaml
id: list_all_records
namespace: company.airtable

tasks:
  - id: get_all_records
    type: io.kestra.plugin.airtable.records.List
    baseId: "{{ secret('AIRTABLE_BASE_ID') }}"
    tableId: "Orders"
    apiKey: "{{ secret('AIRTABLE_PERSONAL_ACCESS_TOKEN') }}"
    maxRecords: 100
    enableAutoPagination: true
    fetchType: FETCH
Properties

API key

Airtable API key for authentication

Airtable base ID

The ID of the Airtable base (starts with 'app')

Table ID or name

The ID or name of the table within the base

Default false

Enable auto-pagination

Whether to automatically fetch all pages of results

Default FETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

How to handle query results

SubType string

Fields

List of field names to retrieve. If not specified, all fields are returned.

Filter by formula

Airtable formula to filter records. Example: AND({Status} != 'Done', {Priority} = 'High')

Maximum records

Maximum number of records to return per page (max 100)

View

Name or ID of a view to use. Records will be returned in the order of the view.

Single record

The first record when fetchType is FETCH_ONE

SubType object

List of records

All records when fetchType is FETCH

Total records

Total number of records retrieved

Format uri

Storage URI

URI of stored records file when fetchType is STORE