Requests & Responses

The Everee API is a set of modern, RESTful HTTP endpoints designed for a good developer experience when integrating. This article covers some useful details you should know about building an integration with Everee.

Always specify JSON

All endpoints in the Everee API both receive and respond with data serialized as JSON. When you make requests to the Everee API, you should specify that the content type of your request body is JSON, and you expect to receive JSON back, with these HTTP headers:

content-type: application/json
accept: application/json

If you provide data to endpoints in formats other than JSON, you'll receive a 400-level HTTP error. If you specify an accept header other than JSON (as shown above), the operation may succeed or fail as normal, but you may not receive a useful error message. Always plan to receive JSON (and use the accept header) to ensure you receive useful error messages when failures occur.

Unique request ID

All responses from the Everee API include a unique ID for that request. It's available in the response headers under the name request_id. If you reach out to Everee Support for help with the API, please include the value of this header if you have it. It'll make it faster for us to help you.