Base URL
All endpoints use HTTPS. HTTP requests are automatically redirected.
Authentication
Include the following headers on every request:Request Format
- All requests and responses use JSON.
- Set
Content-Type: application/jsonon all POST and PATCH requests. - Query parameters are used for GET filters.
Response Format
A standard success response looks like this:Endpoints Summary
Versioning
The current API version is
v1. Breaking changes will be announced with a new version prefix. The v1 endpoints will remain available for at least 12 months after any v2 launch.