To use this library, you need to have a Smartsheet account and an API token. You can get your API token from the Smartsheet Developer Portal. This library currently only supports raw token authentication. Once obtained, you can configure the access token using the Set Access Token keyword or via the access_token argument in the library import.
The library supports working on a single sheet at a time. To select a sheet to work on, use the Select Sheet keyword. This will set the sheet as the active sheet for all subsequent operations. Some operations update the sheet, but this will not necessarily be reflected in the active sheet. To refresh the active sheet, use the Refresh Sheet keyword.
You can retrieve the native Smartsheet object from many keywords by specifying the native argument. The default will return a more common Python object, such as a dictionary or list. The native object is a class from the smartsheet-python-sdk library and will have additional methods and attributes. The most important attributes available for most native objects are (some may be unavailable for some objects):
- id: the unique identifier of the object
- name: the name of the object
- title: the title of a column
- permalink: the URL to the object
If you do not initialize the library with an access token, it will attempt to load the environment variable SMARTSHEET_ACCESS_TOKEN, otherwise, use the keyword Set access token.
|The access token created for your Smartsheet user.|
|Maximum time to allow retries of API calls. Can be provided as a time string or int.|