Requests and responses

The rules every endpoint follows, so the reference can stay short.

Base address

Every endpoint is under https://eos.aveoevents.com/api/v1, over HTTPS only. Paths are lower case with hyphens, such as /checkout/sessions and /discount-codes.

Bodies

Send JSON with Content-Type: application/json. A body must be one JSON object of at most 64 KB. Fields you leave out keep their defaults; unknown fields are ignored. Parameters on GET requests go in the query string.

Ids, times and money

  • Ids. Events, ticket types and webhook endpoints have numbers. Orders use the reference buyers see in their email, O-7KQ2M4X; tickets use the code in their QR, A-7Q2KX9; checkout sessions start cs_.
  • Times are UTC in ISO 8601, such as 2026-12-05T19:00:00.000Z. An event also has a timezone for showing its times locally. Dates without a time, such as report days, are YYYY-MM-DD.
  • Money is a number in the currency’s main unit, with currency beside it in ISO 4217: 25.5 with GBP is £25.50. Ticket prices already include fees.

What comes back

Every object names itself in an object field ("order", "event"), and lists come as a list object. Creating something answers 201; everything else that works answers 200. Removing something answers with its id (or, for a discount code, the code) and "deleted": true. A failure answers with an error object.

New fields, endpoints and webhook event types are added from time to time without a new version, so write code that ignores fields it does not know, and treat values such as status as open lists. livemode on the key check, the company and every webhook is false in your sandbox.

Headers on every response

HeaderWhat it says
X-Request-IdThis request’s id, also in error bodies as request_id and on the API keys page. Quote it when you ask AVEO about a request.
AVEO-VersionThe API version that answered, currently 2026-11-15.
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-ResetThe key’s limit a minute, what is left, and when the minute ends. See rate limits.
Idempotent-Replayedtrue when the answer is a stored one for a repeated Idempotency-Key. See idempotency.
Cache-ControlAlways no-store: answers are never cached on the way.
X-Content-Type-Options, X-Frame-Options, Referrer-Policynosniff, DENY and no-referrer: an answer is only ever data.

Expanding

Some lists can include related objects to save requests. GET /events?expand=ticket_types returns each event with its ticket types and what is left. One event, GET /events/{id}, always includes them.

From a browser

Web pages can call the API with a publishable key from the web addresses listed on it. EOS answers the browser’s preflight check and allows the headers Authorization, Content-Type, Idempotency-Key, X-API-Key and AVEO-Version, and lets your page read the response headers above. Secret keys are refused in browsers.

JavaScript
// in a page on https://www.example.com, which the publishable key allows
const res = await fetch("https://eos.aveoevents.com/api/v1/events?expand=ticket_types", {
  headers: { Authorization: "Bearer eos_pk_12_..." },
});
const { data: events } = await res.json();

Security

Call the API over HTTPS only. Keep keys out of addresses, logs and front-end code, and check that your HTTP client verifies certificates. Every key is checked on every request, so a revoked or expired key stops working at once.