Your Workspace ID is the first 8 characters after https://app.smartsuite.com/ in the address bar. Your API key is in My Profile (profile icon, upper right) under API Key; click the masked value to reveal and copy it, and regenerate it there if it is ever exposed.
Plan Availability | All plan types |
Permissions | API Key access is limited to individual user accounts. |
Platform | Web, API |
Related Reading |
Why do I need an API key and a 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.
How do I keep the key safe?
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.
Where is my 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.
Where is my 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 "My Profile"
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).
How do I regenerate the 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 "My Profile."
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.
What are common uses?
1. Zapier
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 work
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. A key that leaked
Scenario: You suspect your API Key has been shared accidentally.
Solution: Regenerate your API Key and update all systems using the old key.
Frequently asked questions
How do I get my API key?
Click your profile icon in the upper right, open My Profile, scroll to API Key and click the masked value to reveal it, then copy it.
What is my account or workspace ID?
The eight characters after app.smartsuite.com/ in the URL when you are signed in.
Where do I find solution and table IDs?
Open the solution's menu and choose API Documentation; it lists the IDs for that solution and each of its tables.
Does an integration need its own paid seat?
The key belongs to a member, so the integration acts as that member. A dedicated member with minimal permissions is the safest setup; Service Accounts (listed on the pricing page) give integrations their own identity.
Last verified 21 Oct 2026 against this article as Product wrote it in Jul 2025 and the API Overview article