Appearance
Catalogue
Organisers build campaigns and rewards around your events, and pick which product types count. We import the catalogue when they connect and refresh it about every hour.
| Endpoint | Returns | Notes |
|---|---|---|
GET /v1/events | The account's events, each with its product types. Past events included. | Sorted by event.updatedAt, then event.id. Supports updatedSince. |
json
{
"event": {
"id": "evt_123",
"name": "Summer Night 2027",
"description": null,
"startsAt": "2027-07-03T20:00:00+02:00",
"endsAt": "2027-07-04T04:00:00+02:00",
"updatedAt": "2026-11-10T09:12:44+01:00"
},
"productTypes": [
{
"id": "tt_1",
"name": "Early bird",
"price": { "amount": 2500, "currency": "EUR" }
}
]
}Product types
A campaign counts sales of the product types the organiser selects, and a voucher applies to them. Keep their ids stable: orders refer to them in items[].productType.id.
Changes
Move event.updatedAt when the event or any of its product types changes, a new product type included, so the hourly refresh picks it up.
Past events
Imported orders refer to them, so we need them to place historical sales.
Configuration
In capabilities.catalogue of /v1/account.
| Option | Type | Default | What it does |
|---|---|---|---|
version | string | "v1" | The version you implement, and the prefix of the paths we call. |