Appearance
Overview
GET /v1/account is always there. Everything else is a capability that you advertise in /v1/account and build on its own. Catalogue and orders are read-only and required; vouchers and webhooks are optional. Every path is relative to the base URL the organiser enters.
| Part | Endpoints | Status |
|---|---|---|
| Account | GET /v1/account | Required |
| Catalogue | GET /v1/events | Required |
| Orders | GET /v1/ordersGET /v1/fields (optional) | Required |
| Vouchers | POST /v1/vouchers/upsertPOST /v1/vouchers/delete | Optional |
| Webhooks | GET /v1/orders/{id}POST /v1/webhooks/upsertPOST /v1/webhooks/delete | Optional. The last two only when we register the webhook. |
Conventions
| Authentication | Authorization: Bearer <key>. Answer 401 or 403 when the key does not work. |
| Format | JSON, UTF-8, camelCase properties. We ignore properties we don't know, so you can send more. |
| Records | Each record groups the entities that belong together. References are objects ({ "id": … }) so they can carry more later without new field names. |
| Timestamps | RFC 3339 with an offset, e.g. 2026-11-10T21:03:00+01:00. |
| Money | { "amount": 2500, "currency": "EUR" }: an integer in minor units and an ISO 4217 code. |
| Pagination | ?cursor=. You choose the page size; we suggest at least 100 records, and a page must stay under 10 MB. Respond with { "data": [...], "nextCursor": "…" }, null on the last page. A cursor stays valid for at least an hour. |
| Changes | updatedSince is inclusive. A record's updatedAt moves whenever anything in it changes. |
| Rate limits | Tell us your limit in /v1/account (config.rateLimit.requestsPerMinute, optional) and we stay below it, across all organisers on your platform together. We spread calls evenly rather than in bursts: when there is a lot to do, such as a first import, expect a steady stream close to your limit. Answer 429 with Retry-After when we go over it anyway. |
| Errors | The same for every part: see Error handling. |