Skip to main content

Uploading and Downloading Files from the SmartSuite API

Upload a file to a record with the recordfiles endpoint and download one with the shared-files endpoint, using your API key.

Written by Peter Novosel

The REST API uploads a file to a record's Files and Images field with one POST. It downloads a file with one GET.

Both calls use the same Authorization and Account-Id headers as every other endpoint.

Example: a vendor risk team stores each vendor's SOC 2 report in an Evidence field. A script uploads the new report to the vendor's record when the vendor sends it.

Plan Availability

All plan types. Every request counts toward the monthly API allowance: 25,000 on Team, 100,000 on Professional, 500,000 on Enterprise, custom on Signature. Uploaded files count toward the workspace's file storage.

Permissions

Any member with an API key. The key acts with that member's role and permissions.

Platform

API

Related Reading


Authorization

File requests use the same token authentication as every SmartSuite endpoint, over HTTPS.

Authorization: Token API_KEY_HERE
Account-Id: WORKSPACE_ID_HERE

Your Workspace ID is the 8 characters after app.smartsuite.com/ in the address bar when you are signed in.


Uploading a file

Item.

Value.

Method.

POST.

Endpoint.

Content-Type header.

multipart/form-data.

Body.

files: the binary file data. filename: the file name to store.

In Postman:

  1. Set the method to POST and paste the endpoint.

  2. Add the Authorization and Account-Id headers.

  3. In the body, choose form-data.

  4. Attach the file as files and enter the name as filename.

  5. Select Send.

In the vendor example, {field_slug} is the slug of the Evidence field. The solution's API Documentation lists it.


Downloading a file

The response holds the binary file data with these headers:

Header.

Content.

X-File-Name.

The file name.

Content-Length.

The file size in bytes.

Content-Type.

The MIME type.

Content-Disposition.

inline; filename="{filename}".

Note: Uploaded files count toward your workspace's storage. See File Storage Limits.


Frequently asked questions

Which field does the upload endpoint write to?

A Files and Images field. Put the field's slug in the endpoint after the table ID and the record ID.

Can I upload an image into a SmartDoc through the API?

No. Images and attachments in a SmartDoc are read-only through the API. Upload the file to a Files and Images field instead.

Does an upload count toward my API allowance?

Yes. Each upload or download is one API request. The file also counts toward the workspace's storage.

Where do I find the table ID and record ID?

The solution's API Documentation lists the table IDs and field slugs. A record's ID comes back in the response when you list or create records.

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?