The Setster API is used to control your account's data programmatically. The API is organized around REST and standard HTTP verbs. A consistent envelope is used for all responses alongside response codes to indicate the status of the message and any error codes. JSON is returned on all our API responses with a consistent structure for all messages.

• All requests to the API must be made using HTTPS.
• Majority of API endpoints authenticated
• All requests require your account's company_id to be included
• All POST and PUT should be made via application/json

All responses include a statusCode, description, and some data.

• The statusCode may be null or 0 for a successful operation
• Date formats may be returned with slight variations depending on the endpoint
• Resource IDs are returned as strings.

To use the Setster API, you will need the API key that you can find within your Setster account. Treat your Setster API key as you would any other password taking care to never expose it in any public website's client-side code.

The first step to using the Setster API is to use your key to obtain a session token. To authenticate, you'll need to make a request to the /account/authenticate endpoint with your API key and the email tied to your Setster account. The returned session_token and company_id are used for all API calls.

curl --location --request POST 'https://www.setster.com/api/v2/account/authenticate?email=EMAIL&token=TOKEN'

When the session token expires, a 403 Forbidden response will be received, indicating the need for re-authentication and retrieval of a new token to maintain the connection. Instead of reauthenticating at regular intervals, it is advisable to perform this action as needed.

Occasionally you might encounter errors, but if something seems to be working incorrectly, please reach out to Setster support at support@setster.com.

We recommend using the Setster Postman collection for debugging requests.