Naar de inhoud

API

Versioning.

The version is in the path. Within v1, changes only add.

Laatst bijgewerkt 19 november 2026

De documentatie voor ontwikkelaars is alleen in het Engels beschikbaar.

v1

Every route starts with /v1. Within v1 we only make changes that keep working code working:

  • new endpoints and new optional request fields;
  • new fields in responses and webhook payloads;
  • new webhook event types (you only receive the events an endpoint subscribes to).

So your code should ignore fields it doesn't know. A change that removes or renames something would come as a new version in a new path.

Changes

Every change to v1 is listed here with its date, newest first. None yet: v1 is as first published. A new version would be announced here and by email to every company with an API key, before it replaces v1.

The spec

GET /v1/openapi.json is the OpenAPI 3.1 document of the current v1, generated from the code that serves it, so it can't drift from the API. It needs no key: use it to generate a client or to import the API into a tool like Postman. The API reference is built from it; these pages explain what it doesn't, like errors, limits and webhooks.