Developers

Authentication and scopes

Tokens, scopes and what a token can see.

Send the token in the Authorization header of every request:

Authorization: Bearer tixxy_live_...

Tokens starting with tixxy_live_ work with real data; tixxy_test_ tokens only with test data.

What a token can do

A request only succeeds when all of these allow it:

CheckWhere it is set
The token's organisationChosen when creating the token. Other organisations do not exist for it.
The token's scopesChosen when creating the token.
The owner's permissionsThe permission groups of the person who created the token, checked live on every request.
The owner's event restrictionsMembers limited to some events only see those events.
The token's event selectionOptional, set when creating the token.
The token's IP allowlistOptional, set when creating the token.

Objects outside the token's organisation or events return 404, not 403, so a token cannot find out they exist.

A token stops working when its owner leaves the organisation, loses API access or when it expires.

Scopes

ScopeAllows
events:readList and retrieve events
events:writeCreate and update events
ticket-types:readList and retrieve ticket types
ticket-types:writeCreate, update and delete ticket types
orders:readList and retrieve orders
orders:writeCreate, cancel and resend orders (fees apply)
tickets:readList and retrieve tickets, including check-in status
tickets:writeInvalidate tickets and resend download links
attendees:readInclude personal data (names, email, form answers) in orders, tickets and guest list entries
check-ins:writeCheck tickets in
promocodes:read / promocodes:writeRead and manage promo codes
products:readList and retrieve products
guest-lists:readList and retrieve guest list entries
reports:readSales summary per event
webhooks:manageManage webhook endpoints

Without attendees:read, personal data is left out of every response.

GET /v1/me returns the token's organisation, owner, scopes and limits.

On this page