Versioning

The version is part of the URL: every endpoint on this site is under https://app.sparro.dk/api/v2, which is version 2. The shape of /api/v2 is stable. Additions do not need a new version.

What can change without notice

• New endpoints, and new optional fields on a request.
• New fields in a response, and new event types in a webhook.
• New error codes on an endpoint that already returns error codes.

Write your client to ignore a field or an event type it does not know, and to treat an unknown error code like any other failure of that status.

Where changes are listed

Every addition and removal is listed in the changelog. The OpenAPI document and the Postman collection on Postman & OpenAPI describe the same operations as these pages.