# Smartsheet

<!-- BEGIN GENERATED:intro -->

The Smartsheet connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for Smartsheet.

To create a new Smartsheet source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for Smartsheet-specific configuration and networking. For the complete property reference, see the [official Smartsheet driver documentation ↗](https://cdn.cdata.com/help/BSM/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟢 Generally available |
| Batch syncs | 🟢 Generally available |
| Incremental | 🟢 Generally available |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟢 Generally available |
| [Table exports](#table-exports) | 🟢 Generally available |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`UseLegacyAPI` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_UseLegacyAPI.htm) | Mandatory | Determines what API to use for discovering table metadata (and some columns metadata as well). | `FALSE` |
| [`AuthScheme` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_AuthScheme.htm) | Recommended | Specifies the authentication method to use when connecting to Smartsheet. | `PersonalAccessToken` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_InitiateOAuth.htm) | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | `REFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_OAuthClientId.htm) | Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_OAuthClientSecret.htm) | Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.) | — |
| [`PersonalAccessToken` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_PersonalAccessToken.htm) | Recommended | Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface. | — |
| [`Region` ↗](https://cdn.cdata.com/help/BSM/jdbc/RSBSmartsheet_p_Region.htm) | Recommended | Specifies the hosting region for your Smartsheet account. | `GLOBAL` |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| api.smartsheet.com | If `Region=GLOBAL` (default) |
| api.smartsheet.eu | If `Region=EU` |
| api.smartsheetgov.com | If `Region=GOV` |
| app.smartsheet.com | Only for Authorization URL, If `Region=GLOBAL` (default) |
| app.smartsheet.eu | Only for Authorization URL, If `Region=EU` |
| app.smartsheetgov.com | Only for Authorization URL, If `Region=GOV` |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->

### Connection settings

The URL field cannot be modified and is fixed as `jdbc:smartsheet:`. The `JDBC properties` section can be used as an alternative to modifying the JDBC URL.

For example, to represent the following JDBC URL:
`jdbc:smartsheet:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;`, you can specify the additional properties in the `JDBC properties` section as follows:

![Smartsheet connection settings.](../../../assets/27e96ec496c8ad995e8ec6ebd6a7c4b9b5065a694f59aca6d77bd59da9ae91d8.webp)