SmartSuite API Overview
The SmartSuite REST API allows you to integrate your SmartSuite solutions with external systems seamlessly. It adheres to REST standards, encodes objects in JSON, and uses standard HTTP codes to signal outcomes of operations.
Details | Answers |
Plan Availability | All plan types with varying limitations |
Permissions | Administrators: Generate API keys and manage API usage |
Related Reading |
What Can You Do with the SmartSuite 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.
Getting 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: Access 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.
REST API Limits
To ensure stability and security, the SmartSuite API enforces limits on request rates and total usage.
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.
Practical Scenarios and Use Cases
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.