Smartsheet
Version
This integration utilizes the Smartsheet REST API v2.0.
Base URL
The base URL used for all Smartsheet API endpoints:https://api.smartsheet.com/2.0
Authentication & Authorization
The DataGrail Smartsheet integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.
Scopes
The Smartsheet integration requires specific scopes that must be granted in order to function for a given capability.
| Scope | Access |
|---|---|
read_contacts | ✅ |
read_sheets | ✅ |
read_users | ✅ |
Endpoints Utilized
DataGrail uses the following endpoints to authorize and test the connection:
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| POST | /token | Get and refresh access token | |
| GET | https://app.smartsheet.com/b/authorize | Request authorization |
Limits
Limits in Smartsheet are calculated using the leaky
bucket algorithm. All requests that are made after rate limits have been
exceeded are throttled and an HTTP 429 Too Many Requests error is returned.
Requests succeed again after enough requests have emptied out of the bucket.
- DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
- DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Capabilities
Access
DataGrail's Smartsheet integration provides Synchronous Access capabilities for the following supported identifier category: Email.Data Interactions
For Access requests, DataGrail will take the following actions:
- Search users using configured identifiers.
- Get through the list of all contacts and filter by configured identifiers.
- Searches all sheets that the user can access using configured identifiers.
- Get details for each of the collected sheets by the sheet ID.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /contacts | Search for users | |
| GET | /search | Searches all sheets that the user can access | |
| GET | /sheets/sheet_id | Get details for each of the collected sheets | |
| GET | /users | Search for users |
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.