Plan Availability | All plan types |
Permissions | API Key access is limited to individual user accounts. |
Related Reading |
Why Do You Need an API Key and Workspace ID?
SmartSuite integrations, such as Zapier or direct API connections, require two critical pieces of information:
API Key: Grants access to your workspace via API requests.
Workspace ID: Identifies your specific workspace in SmartSuite.
Security Tips for Using API Keys
Treat your API Key like a password. Do not share it with others.
Only copy your API Key directly from the SmartSuite interface when configuring integrations—avoid storing it elsewhere.
Pro Tip: Create a dedicated SmartSuite account for integrations (e.g., Zapier) with the minimal permissions required for your tasks. This ensures better security.
Retrieving Your Workspace ID
Steps:
Log In: Access your SmartSuite workspace at app.smartsuite.com.
Locate the URL: In your browser’s address bar, look for the following format:
https://app.smartsuite.com/<WorkspaceID>Workspace ID: The first 8 characters after
https://app.smartsuite.com/represent your Workspace ID.
Retrieving Your API Key
Steps:
Log In: Access your SmartSuite workspace.
Access API Key Settings:
Click your user icon in the upper-right corner of the interface.
Select the API Key option.
Reveal the Token:
Your user profile will open; scroll to the API Key section.
Click on the
***to display your token.
Copy the Key:
Double-click the token and press
CTRL+C(orCMD+Con Mac) to copy it.Paste it into the appropriate field in your integration setup (e.g., Zapier).
Regenerating Your API Key
If you suspect your API Key has been shared or compromised, you can regenerate it. Warning: Regenerating a key invalidates the old one immediately, so update any systems using the key.
Steps:
Log In: Access your SmartSuite workspace.
Open API Key Settings:
Click your user icon and select the API Key option.
Destroy Existing Key:
In the API Key section, click Destroy Token.
Generate New Key:
Click Generate New Key to create a new token.
Copy the new key and update it in your integrations.
Practical Scenarios and Use Cases
1. Zapier Integration
Scenario: Automate workflows between SmartSuite and other tools like Gmail or Slack.
Solution: Use your API Key and Workspace ID to connect SmartSuite to Zapier.
2. Custom API Solutions
Scenario: Build a custom dashboard to pull data from SmartSuite.
Solution: Use your API Key to authenticate requests and your Workspace ID to specify the workspace.
3. Enhanced Security
Scenario: You suspect your API Key has been shared accidentally.
Solution: Regenerate your API Key and update all systems using the old key.