Postman is a great tool for exploring REST APIs and is extremely useful to understand the calls and data formats you’ll use to interact with SmartSuite.
Download Postman here: https://www.postman.com/
In Postman, you first create a collection, which is a group of API requests. Just click “New” and select “Collection” to get started.
When you create the collection, you can optionally specify authentication credentials for all of the requests that the collection will contain. This is handy in that you don’t have to manually configure the Authorization header for every request. Do this.
Select the “Auth” tab
Set Type to “API Key”
For the Key value, type Authorization
For the Value, type in “Token [SmartSuite API Key]”
It should look something like this:
Setting up Requests
Once you have your collection configured, you need to add a request. Do that from the collection’s 3-dot menu by clicking “Add Request.”
You’ll get something that looks like this:
Now you need to configure the request with:
If you didn’t specify authorization at the collection level, you need to include it in the header:
Name: “account-id”
Value: “Token [API Key]” ← put a space between Token and the id!
A header value: account-id
The method: GET, POST, PATCH, DELETE etc.
The API endpoint URL
Any body parameters that are required (as “raw” type “JSON”)
You get your account ID from the SmartSuite app URL, like this:
Then you’ll create a header value called “account-id” and set it’s value to those 8 characters.
Now it’s time to configure the actual request. Start with this:
Method: GET
Enter those values, save the request, then hit Send to see if it works. If everything is configured correctly, you should see JSON in the bottom of the display (this call returns your own user profile, and is always a good simple test to validate that your credentials are working properly.)
NOTE: the trailing forward slash is important, the call will fail without it!
