API Reference
Every endpoint the Supliful public API serves.
These pages are built from the OpenAPI spec the API itself serves at
GET /v1/openapi.json, so they always describe the deployed contract rather
than a copy of it. Fetch that document directly if you would rather generate a
client than read prose — it needs no API key.
Pick an endpoint from the sidebar to see its parameters, request body, and
every response it can return. Error responses are RFC 9457 problem documents —
each type is documented under Errors.
These pages cover requests you send. For the events Supliful sends you, see Webhooks.