Skip to contents

High-level functions (air_*)

User-facing functions for reading, writing, and working with Airtable data

air_read()
Read records from an Airtable table
air_read_attachments()
Read attachments from records
air_write()
Write (create) records in an Airtable table
air_write_attachments()
Upload attachments to records
air_sync()
Smart sync: diff-based upsert + delete
air_sync_attachments()
Smart sync attachments
air_upsert()
Upsert records into an Airtable table
air_delete()
Delete records from a table (high-level)
air_left_join() air_inner_join() air_full_join()
Join local data with an Airtable table
air_left_join_upload()
Upload local data to matched Airtable records
air_api_usage()
Report Airtable API usage for a workspace
air_set_token()
Set the default Airtable token for this session
air_set_base()
Set the default Airtable base for this session
air_browse()
Open an Airtable workspace, base, table, or view in the browser
air_connect()
Connect to Airtable via DBI
air_pane()
Open the Airtable Connection Pane
air_resolve_id()
Resolve an Airtable ID or URL to its component parts

Demo

Functions for creating and running a live demo walkthrough

air_demo()
Run an interactive airtable2 demo walkthrough
air_demo_setup()
Set up a demo Airtable base for exploration

Special types & helpers

S3 classes and helpers for Airtable special field types

air_flatten()
Flatten a complex Airtable column to a simple atomic vector
air_flatten_multiselect()
Flatten a multi-select list-column to delimited strings
air_flatten_links()
Flatten a record-links list-column to delimited strings
air_flatten_attachments()
Flatten an attachments list-column to a summary string
air_flatten_collaborator()
Flatten a collaborator list-column to strings
air_expand_multiselect()
Expand delimited strings to a multi-select list-column
air_expand_collaborator()
Expand collaborator strings to list-column
air_simplify()
Simplify all complex columns in a tibble for display/export
air_attachment_preview_url()
Get a stable preview URL for an Airtable attachment

Metadata & backup

Schema inspection, base metadata, and backup/restore

air_meta()
Get base metadata as a flat tibble
air_meta_push()
Push metadata changes back to the base
air_meta_sync()
Sync a metadata source to patch the base schema
air_meta_init()
Seed the _metadata table from the live schema
air_schema()
Get schema for a base as a tidy tibble
air_dump()
Dump an entire base (schema + data) for backup
air_restore()
Restore a base from a dump
air_field_template()
Build a field template specification
air_table_template()
Build a table template specification

Request building & authentication

Low-level helpers for constructing and authenticating API requests

air_req()
Build an httr2 request to the Airtable API
air_token()
Resolve an Airtable personal access token

Low-level API wrappers (at_*)

Direct Airtable REST API wrappers — use air_* for most tasks

at_sitrep()
Summarize Airtable situation report
at_list_records()
List records from a table
at_get_record()
Get a single record
at_create_records()
Create records in a table
at_update_records()
Update multiple records
at_delete_records()
Delete records
at_list_bases()
List all accessible bases
at_get_base()
Get information about a single base
at_get_schema()
Get the schema (tables + fields) for a base
at_get_collaborators()
Get collaborators for a base
at_create_base()
Create a new base
at_create_table()
Create a table in a base
at_update_table()
Update table metadata
at_create_field()
Create a field in a table
at_update_field()
Update field metadata
at_list_views()
List views in a table
at_get_view()
Get a specific view's metadata
at_upload_attachment()
Upload an attachment to a record field
at_whoami()
Get current user info

DBI interface

DBI-compatible S4 interface for Airtable connections

Internal