The SmartSuite REST API lets external systems retrieve, create, update and delete records in your tables. Generate an API key in Workspace Administration, then open API Documentation from a solution's menu for examples built from your own tables.
Details | Answers |
Plan Availability | All plan types with varying limitations |
Permissions | Administrators: Generate API keys and manage API usage |
Platform | API |
Related Reading |
My API requests fail or are throttled: check these four things, in order
Administrators generate API keys and manage API usage. If you are not an Administrator, send this page and the response you received to one.
A 429 error. Standard usage is 5 requests per second per user; retry after 30 seconds. See Rate limits.
Requests slowed to 2 per second. The workspace passed its monthly allowance; above 125 percent requests are denied until the next month. See What are the API limits?.
No API key. An Administrator generates the key in Workspace Administration. See Step 1: Generate an API key.
More calls before the reset. An Administrator buys add-on blocks of 1,000 calls or turns on auto-billing. See Frequently asked questions.
Still stuck: select the chat button in the lower-right corner of SmartSuite. The last block of the panel shows the service status, and Send a message in the same panel reaches support. Include the workspace name, the endpoint, the response code and the time of the request. The limits in detail are in API Transaction Limits.
What can I do with the REST API?
With the SmartSuite REST API, you can perform four main actions:
Retrieve Records: Access data from your SmartSuite tables.
Create Records: Add new entries to your solutions.
Update Records: Modify existing entries.
Delete Records: Remove records from your solutions.
How do I get started?
Step 1: Generate an API key
To begin using the API, generate an API key for your workspace. For detailed instructions, see the Generating an API Key article.
Step 2: Open the API documentation
The API documentation provides detailed, solution-specific and table-specific examples based on your environment. Follow these steps to access it:
From the SmartSuite homepage, select the solution you want to integrate with.
Click the small arrow next to the solution name.
Select API Documentation.
The API documentation will open in a new tab, ready for you to explore.
SmartSuite also offers more in-depth technical documentation on our developers site.
What are the API limits?
The API has a rate limit and a monthly call allowance. Monthly API calls: 5,000 on Team, 50,000 on Professional, 250,000 on Enterprise and custom on Signature. Add-on blocks of 1,000 calls cost $15 each and do not carry over to the next month.
Rate limits
Standard Usage: 5 requests per second, per user.
Overage Limit: When exceeding your API request allowance, the limit drops to 2 requests per second, per user.
Hard Limit: Requests exceeding 125% of the monthly limit will be denied until the next month.
For more details, visit the API Limits article.
Is there a Webhooks API?
Yes. The Webhooks API notifies your server when records change, so you do not have to poll. It is documented at developers.smartsuite.com (Solution Data, Webhooks) and is separate from the Webhook automation trigger and the Send Webhook Request action.
Endpoints: List, Create, Get, Update and Delete Webhook, and List Events. Authentication is your API key and the ACCOUNT-ID header, from server-side code only.
Push, then pull: SmartSuite sends a POST ping to your notification URL with the webhook ID and a locator, and no record data. Your server returns 200, then calls List Events to fetch the changes. Delivery is at least once, so deduplicate on event_id.
Retries: a failed ping is retried with exponential backoff for about a day. After that the webhook's notifications are disabled, but events keep collecting.
Expiry: call List Events at least every 7 days, or notifications are disabled. A disabled webhook and its events are deleted after a further 7 days; a List Events call in that window re-enables it.
Rate limit: the same as the REST API, 5 requests per second per key.
Monthly allowance: the ping SmartSuite sends is not an API request and does not count. The calls you make (List Events, Create or Update Webhook) are REST API requests and count like any other.
What are common ways to use the API?
1. Data synchronization
Scenario: A company needs to sync customer data between SmartSuite and their CRM system.
Solution: Use the API to automate the retrieval and updating of customer records, ensuring both systems stay in sync.
2. Custom reporting
Scenario: The sales team wants to generate custom reports not available in SmartSuite’s native interface.
Solution: Use the API to extract data and feed it into a third-party reporting tool.
3. Automated data entry
Scenario: A marketing team collects survey data from an external platform and wants to integrate it into SmartSuite.
Solution: Create a script using the API to automate the transfer of survey responses into SmartSuite tables.
For more details about these limits see the article API Limits.
Frequently asked questions
Where do I find the API documentation for my solution?
Where do I find the API documentation for my solution?
On the SmartSuite home page, click the small arrow next to the solution name and choose API Documentation. It opens in a new tab with examples for that solution's tables. The general developer documentation is on the developers site linked above.
I hit the monthly API limit. How do I restore access before the reset?
I hit the monthly API limit. How do I restore access before the reset?
An Administrator can buy add-on blocks of 1,000 calls ($15 each) under Plans & Billing, which restores full access at once, or turn on auto-billing so blocks are bought automatically at 100 percent. Without add-ons, calls throttle to 2 per second up to 125 percent of the allowance and are then blocked until the next month.
What happens when I exceed the rate limit?
What happens when I exceed the rate limit?
Requests above 5 per second per user return a 429 error; retry after 30 seconds.
Can an AI assistant such as Claude read and write my workspace?
Can an AI assistant such as Claude read and write my workspace?
Yes, through the SmartSuite MCP Server, which gives AI clients governed access to your data. See SmartSuite MCP Server.
Do I need a paid seat for an integration?
Do I need a paid seat for an integration?
Service Accounts give integrations their own identity for authentication; the pricing page lists which plans include them. Otherwise the API key belongs to a member.
Last verified 26 Oct 2026.