The SmartSuite REST API gives you the ability to create, update and delete records in bulk using special bulk endpoints.
Note that SmartSuite does not consider adding keys to response objects as breaking changes, so the shape of objects may change without notice. Existing keys will not be removed without a deprecation warning and timeframe.
Authorization
SmartSuite uses token-based authentication for metadata requests. You can generate or manage your API key in your User Profile. All API requests must be authenticated and made over HTTPS.
IMPORTANT! Your API key conveys the same privileges as the Member account it is generated in, so it should be treated as securely as a password.
You authenticate to the API by providing your API key in the Authorization header, as well as your Workspace Id in an Account-Id header, as shown below.
KEY:VALUE
Authorization: Token API_KEY_HEREAccount-Id: WORKSPACE_ID_HERE
NOTE: Your Workspace Id is the 8 characters that follow https://app.smartsuite.com/ in the SmartSuite URL when you’re logged in.
Example: https://app.smartsuite.com/sv25cxf2/solution/62c4b…
Bulk Record Endpoints
The following bulk record endpoints are available in the v1 REST API.
Bulk Add Records
POST https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk/
Adds multiple records. The body of the request should have the following shape:
{
"items": [
{
"title":"record 1",
"description":"test"
},
{
"title":"record 2",
"description":"test2"
},
{
"title":"record 3",
"description":"test3"
}
]
}
Bulk Update Records
PUT (replace all record values)
PATCH (update specified values)
https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk/
Updates multiple records. The body of the request should have the following shape:
{
"items": [
{
"id": "6418b913ac9e9b98c222d5a3",
"priority": "high"
},
{
"id": "6418b913ac9e9b98c222d5a4",
"priority": "high"
}
]
}
Bulk Delete Records
PATCH
https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk_delete/?fields=id
Updates multiple records. The body of the request should have the following shape:
{
"items": [
"6418b7a1f2f4056dd0279a54",
"6418b7a2fe6b4a731195c245",
"6418b7a2db77680b279fd3f8"
]
}