Smartsheets
Set up the Smartsheets source connector by following this guide.
Prerequisites
To configure the Smartsheet Source for syncs, you’ll need:
- A Smartsheets API access token generated by a Smartsheets user with at least read access
- The ID of the spreadsheet you want to sync
Step 1: Set up Smartsheets
Get an API access token
Generate an API key from your Smartsheet webapp session by selecting:
- Account (top-right icon)
- Apps & Integrations
- API Access
- Generate new access token
For guidance on advanced authorisation flows, see this.
Find your spreadsheet ID
You’ll also need the ID of the Spreadsheet you want to sync. Unlike Google Sheets, this ID isn’t in the URL. Find the required spreadsheet ID in your Smartsheet app session by selecting:
- File
- Properties
Step 2: Set up the connector
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, name the Smartsheets connector. Then select Smartsheets from the Source type dropdown.
- Authenticate through OAuth2.0 using the API access token from Prerequisites.
- Enter the start date and the ID of the spreadsheet you want to sync.
- Submit the form.
For Airbyte Open Source:
- Go to the Airbyte Open Source dashboard.
- Set the name for your source.
- Enter the API access token from Prerequisites.
- Enter the ID of the spreadsheet you want to sync.
- Enter a start sync date.
- Click Set up source.
Supported sync modes
The Smartsheets source connector supports these sync modes:
- Full Refresh | Overwrite
- Full Refresh | Append
- Incremental | Append
- Incremental | Deduped
Performance considerations
At the time of writing, the Smartsheets API rate limit is 300 requests per minute for each API access token.
Supported streams
This source provides one stream for each spreadsheet. Its dynamic schema depends on your spreadsheet structure.
For example, a spreadsheet named Customers creates a stream with the same name. Its properties follow the Data type map shown in below.
You can also include specific sheet or row metadata fields in the stream. Specify these fields in the configuration to include them.
| Supported Metadata Fields |
|---|
| sheetcreatedAt |
| sheetid |
| sheetmodifiedAt |
| sheetname |
| sheetpermalink |
| sheetversion |
| sheetaccess_level |
| row_id |
| row_access_level |
| row_created_at |
| row_created_by |
| row_expanded |
| row_modified_by |
| row_parent_id |
| row_permalink |
| row_number |
| row_version |
Key details
The Smartsheet Source pulls data from one Smartsheet spreadsheet. Unlike Google Sheets, Smartsheets allows only one sheet per Smartsheet. Each Airbyte connector instance can therefore sync only one sheet at a time. To replicate multiple spreadsheets, create multiple Smartsheet Source instances in Airbyte. You can reuse the API token across every sheet you need to sync.
Note: Column headers must contain only alphanumeric characters or _ , as specified in the Airbyte Protocol.
Data type map
This connector’s data type mapping is based on the Smartsheet documentation.
NOTE: For column data types interpreted by Smartsheets, except DATE and DATETIME, the connector assumes a string type. In this case, Airbyte doesn’t require the format field.
| Integration Type | Airbyte Type | Airbyte Format |
|---|---|---|
TEXT_NUMBER | string | |
DATE | string | format: date |
DATETIME | string | format: date-time |
anything else | string |
Smartsheets supports other, more complex column data types, such as Predecessor and Dropdown List. This connector supports only their string representation.
IP allow list
If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.1.46 | 2025-05-25 | 60558 | Update dependencies |
| 1.1.45 | 2025-05-11 | 60205 | Update dependencies |
| 1.1.44 | 2025-05-04 | 59584 | Update dependencies |
| 1.1.43 | 2025-04-27 | 59014 | Update dependencies |
| 1.1.42 | 2025-04-19 | 58374 | Update dependencies |
| 1.1.41 | 2025-04-12 | 57999 | Update dependencies |
| 1.1.40 | 2025-04-05 | 57490 | Update dependencies |
| 1.1.39 | 2025-03-29 | 56830 | Update dependencies |
| 1.1.38 | 2025-03-22 | 55651 | Update dependencies |
| 1.1.37 | 2025-03-01 | 55076 | Update dependencies |
| 1.1.36 | 2025-02-22 | 54529 | Update dependencies |
| 1.1.35 | 2025-02-15 | 54107 | Update dependencies |
| 1.1.34 | 2024-11-14 | 46379 | Add support for Smartsheet Reports (full refresh only) |
| 1.1.33 | 2025-02-01 | 53108 | Update dependencies |
| 1.1.32 | 2025-01-25 | 52426 | Update dependencies |
| 1.1.31 | 2025-01-18 | 52017 | Update dependencies |
| 1.1.30 | 2025-01-11 | 51402 | Update dependencies |
| 1.1.29 | 2024-12-28 | 50747 | Update dependencies |
| 1.1.28 | 2024-12-21 | 50382 | Update dependencies |
| 1.1.27 | 2024-12-14 | 49441 | Update dependencies |
| 1.1.26 | 2024-11-25 | 48646 | Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64 |
| 1.1.25 | 2024-11-04 | 48185 | Update dependencies |
| 1.1.24 | 2024-10-28 | 47024 | Update dependencies |
| 1.1.23 | 2024-10-12 | 46783 | Update dependencies |
| 1.1.22 | 2024-10-05 | 46427 | Update dependencies |
| 1.1.21 | 2024-09-28 | 46154 | Update dependencies |
| 1.1.20 | 2024-09-21 | 45722 | Update dependencies |
| 1.1.19 | 2024-09-14 | 45575 | Update dependencies |
| 1.1.18 | 2024-09-07 | 45214 | Update dependencies |
| 1.1.17 | 2024-08-31 | 45012 | Update dependencies |
| 1.1.16 | 2024-08-24 | 44738 | Update dependencies |
| 1.1.15 | 2024-08-17 | 44244 | Update dependencies |
| 1.1.14 | 2024-08-10 | 43686 | Update dependencies |
| 1.1.13 | 2024-08-03 | 43108 | Update dependencies |
| 1.1.12 | 2024-07-27 | 42632 | Update dependencies |
| 1.1.11 | 2024-07-20 | 42359 | Update dependencies |
| 1.1.10 | 2024-07-13 | 41825 | Update dependencies |
| 1.1.9 | 2024-07-10 | 41410 | Update dependencies |
| 1.1.8 | 2024-07-09 | 41092 | Update dependencies |
| 1.1.7 | 2024-07-06 | 40844 | Update dependencies |
| 1.1.6 | 2024-06-25 | 40285 | Update dependencies |
| 1.1.5 | 2024-06-22 | 40003 | Update dependencies |
| 1.1.4 | 2024-06-06 | 39166 | [autopull] Upgrade base image to v1.2.2 |
| 1.1.3 | 2024-05-21 | 38505 | [autopull] base image + poetry + up_to_date |
| 1.1.2 | 2024-01-08 | 1234 | prepare for airbyte-lib |
| 1.1.1 | 2023-06-06 | 27096 | Fix error when optional metadata fields are not set |
| 1.1.0 | 2023-06-02 | 22382 | Add support for ingesting metadata fields |
| 1.0.2 | 2023-05-12 | 26024 | Fix dependencies conflict |
| 1.0.1 | 2023-04-27 | 25562 | Update testing dependencies |
| 1.0.0 | 2023-02-19 | 23237 | Fix OAuth2.0 token refresh |
| 0.1.14 | 2023-02-07 | 22419 | OAuth2.0 support - enabled; add allowed hosts |
| 0.1.13 | 2022-12-02 | 20017 | OAuth2.0 support - disabled |
| 0.1.12 | 2022-04-30 | 12500 | Improve input configuration copy |
| 0.1.11 | 2022-04-27 | 12203 | Doc improvements |
| 0.1.10 | 2022-04-15 | 12077 | Implement incremental read and improve code test coverage |
| 0.1.9 | 2022-04-12 | 11911 | Bugfix: scrambled columns |
| 0.1.8 | 2022-02-04 | 9792 | Added oauth support |