Skip to main content

API Overview: connect SmartSuite with the REST API

Read, create, update and delete records from another system with the REST API, your API key and the call allowance.

Written by Peter Novosel

The SmartSuite REST API lets another system read, create, update and delete records in your tables. You authenticate with an API key, and each solution has its own API Documentation built from your tables.

Here is the test: does data need to move between SmartSuite and another system without a person copying it? If yes, the API is the way.

Example: a vendor risk program keeps a Vendors table in SmartSuite. The procurement system creates a vendor record through the API when a contract is signed. Each night, a reporting job reads the open findings for the board report.

Plan Availability

All plan types. Monthly API calls: 25,000 on Team, 100,000 on Professional, 500,000 on Enterprise, custom on Signature.

Permissions

Any member generates a key for their own account. Administrators see the workspace's API usage.

Platform

API

Related Reading


My API requests fail or slow down: check these four things, in order

Any member with an API key can send requests. Administrators see the usage and buy more calls. If you are not an Administrator, send this page and the response you received to one.

  1. A 429 error. You sent more than 5 requests per second. Wait 30 seconds, then retry. See API Transaction Limits.

  2. Requests slowed to 2 per second. The workspace passed its monthly allowance. Above 125 percent, requests are refused until next month. See Check and reduce API usage.

  3. No API key. Each member generates their own key in My Profile. See Generating an API Key.

  4. More calls needed before the reset. An Administrator buys add-on blocks of 1,000 calls. See API Transaction Limits.

Still stuck: open the chat button in the lower-right corner of SmartSuite and select Send a message. Include the workspace name, the endpoint, the response code and the time of the request.


What can the API do?

The REST API works with the records in your tables. It has four main actions:

  • Retrieve records: read data from a table.

  • Create records: add new records.

  • Update records: change existing records.

  • Delete records: remove records.

Separate endpoints read and change the structure: solutions, tables, fields and members. They are in Metadata API documentation.


How do I start?

  1. Generate your API key in My Profile, as Generating an API Key shows.

  2. Copy your Workspace ID: the first 8 characters after app.smartsuite.com/ in the address bar.

  3. Open the solution and select the small arrow next to its name in the top bar.

  4. Select Developer Docs. The API documentation opens in a new tab with examples built from that solution's tables.

The solution menu, opened from the arrow next to the Enterprise Risk Management solution name, with Developer Docs highlighted.

The solution menu, opened from the arrow next to the Enterprise Risk Management solution name, with Developer Docs highlighted.

Every request carries two headers: your key and your Workspace ID.

Authorization: Token API_KEY_HERE
Account-Id: WORKSPACE_ID_HERE

Tip: The general reference for every endpoint is the SmartSuite developer documentation.


How many calls can I make?

Two rules apply: a rate per second and an allowance per month.

  • Rate: 5 requests per second, per member. Above that, requests return a 429 error. Retry after 30 seconds.

  • Monthly allowance: 25,000 calls on Team, 100,000 on Professional, 500,000 on Enterprise and custom on Signature.

  • Over the allowance: the rate drops to 2 requests per second, per member.

  • Hard stop: above 125 percent of the allowance, requests are refused until the next month.

Add-on blocks of 1,000 calls cost $15 each. They do not carry over to the next month.

Note: Every request counts, whatever tool sends it. Zapier, Make and other connected apps use your API key, so their calls count too.


Is there a Webhooks API?

Yes. The Webhooks API tells your server when records change, so you do not have to keep asking. It is separate from the Webhook automation trigger and the Send Webhook Request action. The details are in the developer documentation for webhooks.

  • Endpoints: List, Create, Get, Update and Delete Webhook, and List Events. Call them from server-side code only.

  • Push, then pull: SmartSuite sends a short ping to your URL with the webhook ID and a locator, and no record data. Your server returns 200, then calls List Events to get the changes.

  • At least once: a change can arrive twice. Remove duplicates by event_id.

  • Retries: a failed ping is retried for about a day. Then the webhook's pings stop, but events keep collecting.

  • Expiry: call List Events at least every 7 days, or the pings stop. A stopped webhook and its events are deleted 7 days later. A List Events call in that time turns it back on.

  • Counting: the ping SmartSuite sends does not count. The calls you make, such as List Events, count like any other request.

In the vendor example, the reporting system gets a ping when a finding changes. It then calls List Events and updates its copy.


Frequently asked questions

Where do I find the API documentation for my solution?

Open the solution, select the small arrow next to its name in the top bar and choose Developer Docs. It opens in a new tab with examples for that solution's tables.

What happens when I pass the monthly API limit?

Calls slow to 2 per second. Above 125 percent of the allowance, they stop until the next month. An Administrator can buy add-on blocks of 1,000 calls ($15 each) under Plans & Billing, or turn on auto-billing.

What happens when I send more than 5 requests per second?

Requests above 5 per second per member return a 429 error. Wait 30 seconds before you retry.

Can an AI assistant such as Claude read and write my workspace?

Yes, through the SmartSuite MCP Server. It gives AI tools governed access to your data. See SmartSuite MCP Server.

Do I need a paid seat for an integration?

An API key belongs to a member, so the integration acts as that member. Service Accounts give an integration its own identity instead. See Service Accounts in SmartSuite.

Need more help? Ask the SmartSuite Community, where builders, administrators and the SmartSuite team answer questions about building on SmartSuite. For your account, billing or data, select the chat button in the lower-right corner of SmartSuite to reach support.

Last verified 1 Nov 2026.

Did this answer your question?