Skip to main content

Airtable - Download Table or View to Shipyard

Overview​

Quickly export data from a single table on an Airtable base to a CSV.

Only one table or view of data can be downloaded at a time, since CSVs are flat files.

Content of the downloaded file can be further refined by providing a view. Otherwise, the entire contents of the table will be downloaded.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Base IDAIRTABLE_BASE_IDAlphanumericβœ…--The ID of your Airtable base. Found in the URL of your base and starts with app
Table Name or IDAIRTABLE_TABLE_NAMEAlphanumericβœ…--Can be the Name (case sensitive) or the ID of the table. The ID can be found in the URL and always starts with tbl.
View Name or IDAIRTABLE_VIEW_NAMEAlphanumericβž–--Can be the Name (case sensitive) or the ID of the view. The ID can be found in the URL and always starts with viw.
Include Record IDs?AIRTABLE_INCLUDE_RECORD_IDBooleanβœ…True-If checked, an additional column named airtable_record_ids will be created in the CSV containing each row's unique Airtable Record ID. This is recommended if data ever needs to be reloaded back into Airtable in the future.
Personal Access TokenAIRTABLE_API_KEYPasswordβœ…--Personal Access Token associated with a user that has access to the specified Base, Table, and View listed.
Shipyard File NameAIRTABLE_DESTINATION_FILE_NAMEAlphanumericβœ…--Name of file to be generated with the results. Should be .csv extension.
Shipyard Folder NameAIRTABLE_DESTINATION_FOLDER_NAMEAlphanumericβž–--Folder where the file should be downloaded. Leaving blank will place the file in the home directory.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Airtable - Download Table or View to Shipyard
inputs:
AIRTABLE_BASE_ID: null ## REQUIRED
AIRTABLE_TABLE_NAME: null ## REQUIRED
AIRTABLE_VIEW_NAME: null
AIRTABLE_INCLUDE_RECORD_ID: true ## REQUIRED
AIRTABLE_API_KEY: null ## REQUIRED
AIRTABLE_DESTINATION_FILE_NAME: null ## REQUIRED
AIRTABLE_DESTINATION_FOLDER_NAME: null
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '100'
- '101'
- '102'
- '103'
- '104'
- '205'
- '206'