Smartsheet
Smartsheet is a SaaS platform that is helpful for collaboration and work management. this platform is capable to scale from a single project to end-to-end work management. With the help of Smartsheet, you can assign tasks, track project progress, manage calendars, share documents, and manage other work in a simple manner. You can connect this platform with a no-code and cloud-based platform for seamlessly managing your work.
Authorization
Basic Auth
Smartsheet API 2.0 allows you to programmatically access and manage your organization's Smartsheet data and account information. Smartsheet will add new functionality and bug fixes to the API over time. Make sure that your code can handle new JSON properties gracefully. Also, make sure your code does not depend on the order in which JSON objects are returned, unless it is explicitly stated in this documentation. This component wraps the most popular endpoints listed in the Smartsheet API docs. If you need access to an endpoint that is not covered by an action in this component, you can use the Raw Request action to issue a GET, POST, PUT or DELETE against any Smartsheet API endpoint.
OAuth 2.0
API keys can be used for development purposes, though you should use an OAuth 2.0 connection for production integrations. Information about getting started and creating API keys with Smartsheet can be found on their developer documentation site.
The Smartsheet API uses OAuth 2.0 for authentication and authorization. An HTTP header containing an access token is required to authenticate each request.
To familiarize yourself with the API, you can generate a raw token. See Raw Token Requests.
For additional security and as a recommended best practice, you should build an integration using OAuth 2.0. During the OAuth process, you will generate several API keys and, ultimately, each user will generate a unique access token.
Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.
The Smartsheet API utilizes OAuth 2.0 for authentication and authorization. An Authorization HTTP header containing an access token is required to authenticate all API requests except for the requests to GET Access Token or Refresh Access Token. For more information, see Authentication.
{
"access_token": "string",
"token_type": "string",
"expires_in": 604799,
"refresh_token": "string"
}Key | Description | Example |
|---|---|---|
API Key | Provide a string value for the API Key. |
|
Base URL | Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities. |
Key | Default | Notes | Example |
|---|---|---|---|
Authorization URL | Authorization URL |
| |
Base URL | Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities. |
| |
App client id |
| This is generated when you create an app within Smartsheet's 'Developer Tools' | abcdefghijklmnop123 |
App secret |
| This is generated when you create an app within Smartsheet's 'Developer Tools' | abcdefghijklmnop123 |
Scopes | ADMIN_SHEETS ADMIN_SIGHTS ADMIN_USERS ADMIN_WEBHOOKS ADMIN_WORKSPACES CREATE_SHEETS CREATE_SIGHTS DELETE_SHEETS DELETE_SIGHTS READ_CONTACTS READ_EVENTS READ_SHEETS READ_SIGHTS READ_USERS SHARE_SHEETS SHARE_SIGHTS WRITE_SHEETS | A space-separated list of permissions to request. You can remove any permissions that you do not use. Descriptions of each permission is available at https://smartsheet.redoc.ly/#section/Authentication . |
|
Token URL | Token URL |
|
For more information visit Smartsheet Documentation
Smartsheet Connections
Smartsheet Basic Auth Connection
Input | Key | Description | Example |
Select application | application | Select Smartsheet application | Smartsheet |
Connection type | connection type | Select the type of connection. | REST |
Rest connection type | Rest Connection Type | Select the Basic connection type | Basic |
Connection name | name | Provide a name for the connection. | Smartsheet |
Connection description | description | Provide a description for the connection. |
|
Host name | host | Provide a string value for the URL of the user's Smartsheet account. |
|
Username | username | Provide a valid username for the given Smartsheet account. | exampleUser |
Password | password | Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. | exampleSecurePassword |
Header field | header | Provide the path of the endpoint for authentication. | Authorization |
Header prefix header | header prefix | Select the header prefix - |
|
Smartsheet OAuth 2.0 Connection
Input | Key | Description | Example |
Select application | application | Select Smartsheet application | Smartsheet |
Connection type | connection type | Select the type of connection. | REST |
REST connection type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection name | name | Provide a name for the connection. | Smartsheet connection |
Connection description | description | Provide a description for the connection. |
|
Host name | host | Provide a string value for the URL of the user's Smartsheet account. |
|
Grant type | grant type | Provide the grant type - authorization code, password, client credentials. |
|
Smartsheet Api Key Connection
Input | Key | Description | Example |
Select application | application | Select Smartsheet application | Smartsheet |
Connection Mode | mode | Select custom connection mode | Custom |
Connection type | connection type | Select the type of connection. | REST |
REST connection type | rest connection type | Select the type of REST connection. | API Key |
Connection name | name | Provide a name for the connection. | Smartsheet connection |
Connection description | description | Provide a description for the connection. |
|
Host name | host | Provide a string value for the URL of the user's Smartsheet account. |
|
Key | key | Provide the key for the connection. |
|
Value | value | Add the value for the connection |
|
Header Parameter | header | Header parameters are used for user-defined custom HTTP headers for a request. |
|
Query Parameter | query | Query parameters are a defined set of parameters attached to the end of a URL. |
|
Actions
Get Sheets
Get sheets | key: getSheets
Get Sheet
Get sheet | key: getSheet
Key | Description | Example |
|---|---|---|
ID | Provide the id for getting the specific sheet. It’s an unique id that is associated with a particular sheet. | 603843458295684 |
Get Row By ID
Get Row by ID | key: getRowbyID
Key | Description | Example |
|---|---|---|
Sheet ID | Provide the Sheet id. It’s an unique id that is associated with a particular sheet. | 7960873114331012 |
Row ID | An ID of a row to update. Omit to add a new row. The IDs of the rows to move or copy from the source sheet. | 6830028284938 |
Get Sheets in Smart Sheet
Get sheets in Smart Sheet | key: getSheetsSmartSheet
Get Sheets 12
Get sheets 12 | key: getSheets12
Key | Description | Example |
|---|---|---|
Status | This section provides the status for the particular sheet. | Enable and Disable |