Skip to content

Overview

Reference for the customer-facing HTTP API. Request and response examples use synthetic values but follow the payloads returned by the service. Authenticate customer requests with a JWT or API key in the Authorization header.

Information

  • OpenAPI version: 3.0.3

Send Authorization: Bearer YOUR_JWT. API keys are also accepted with the Bearer prefix for compatibility with server integrations.

Security scheme type: http

Bearer format: JWT

Send Authorization: Static YOUR_API_KEY.

Security scheme type: apiKey

Header parameter name: Authorization