Skip to main content
Most of our service endpoint APIs require an API key for authentication. To obtain an API key, please contact us directly and we’ll set you up with the appropriate access credentials.

Request and Response Format

  • Protocol: HTTP/HTTPS
  • Timezone: UTC
  • Response Format: JSON (the health endpoint returns plain text “ok”)
  • Header:
Content-Type: application/json
x-api-key: <YOUR_API_KEY>
The health endpoint does not require x-api-key header, all other write operation endpoints require it.