The file upload API is an interface which can be used in your own applications to securely upload, manage and download files externally from this website.
This API will evolve over time when access to other data within the system is made available. However, none of the current endpoints or response values will change. You can write your integration code knowing that it will now be affected by future updates.
We recommend SSL is used for all requests. You can require SSL by forcing it via your web server.
Every string passed to and from the API needs to be UTF-8 encoded.
All methods are done using POST unless otherwise stated.
All date/times in the API are strings in the following format:
All requests are sent to the follow API host:
Errors are returned using standard HTTP error code syntax. Any additional information is included in the body of the return call, JSON-formatted.
Standard API errors
Bad input parameter. Response error should show which one and why.
Bad or expired token. To fix, you should re-authenticate the user.
File not found at the provided path.
Request method not expected (generally should be GET or POST).
Maximum API request limit reached. Try to reduce the amount of requests or look at raising this via your web server configuration.
"response": "Could not authenticate user. The username and password may be invalid or your account may be locked from too many failed logins.",
"_datetime": "2023-02-02 15:32:29"
All requests to the API must be done with a valid access_token and account_id.
The same 'access_token' can be used multiple times in the same session, so you shouldn't generate a new access_token for each request.
Your external application should make API requests in the following order:
Request an access_token and account_id /authorize.