Offorte API
Welcome to the Offorte API! Here you'll find all the documentation to get your started with integrating your application with Offorte.
If you got cool idea's, feedback or run into issues with the api, please let us know. We love feedback and are here to help you. You can reach us at www.offorte.com/support
Making a request
All URLs start with https://connect.offorte.com/api/v2/[account_name].
Only HTTPS is supported and the path is prefixed with /api/v2/your_account_name.
We use JSON for all API data, there is no root element and we use snake_case for object keys. You have to send the Content-Type header "Content-Type: application/json; charset=utf-8" when you do a POST, PATCH or PUT.
Your account name is the subdomain name in your Offorte account address:
https://companyname.offorte.com/
Pagination
For the list requests we paginate the results. The ratio is 50 items per page. Add the request param page to your request.
For example: https://connect.offorte.com/api/v2/[account_name]/companies/?page=2
Rate limit
To prevent a too heavy load on our servers we've implemented a rate limit of 30 requests per 1 minute.
Errors
The Offorte API uses the following error codes:
| Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API authorisation is wrong. |
| 403 | Forbidden -- The item requested is hidden. |
| 404 | Not Found -- The item could not be found. |
| 405 | Method Not Allowed -- You tried to access an item with an invalid method. |
| 410 | Gone -- The item requested has been removed from our servers. |
| 429 | Too Many Requests -- You're requesting too many items! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Terms of use
The Offorte General Terms and User Terms applies on the use of the API.