Skip to main content
New to Corsair? See API access, authentication, and error handling.

Attendees

checkin

attendees.checkin Check an attendee in, or revert their check-in, by ticket barcode. Passing eventcheckin: true twice is harmless. Risk: write
Input Output

get

attendees.get One attendee by id, with their event, order reference and check-in state. Risk: read
Input Output

Categories

list

categories.list Event category names, for the category filter on events.list. Answers HTTP 200 with an error body rather than a 401 when the key is refused, which this plugin turns into an auth error. Risk: read
Input: empty object Output

Checkout

confirm

checkout.confirm Record the payment result and turn a filled checkout into a confirmed order. Emails the buyer unless sendemail is false. This is the step that completes a registration. Risk: write
Input Output

create

checkout.create Reserve tickets and get one ticket_price_id per ticket plus a checkout id. The order stays incomplete until checkout.confirm, so an abandoned reservation holds inventory without charging anyone. Risk: write
Input
Output

fillOrder

checkout.fillOrder Attach buyer and attendee details to a reserved checkout. Nothing is charged and no email is sent until checkout.confirm. Risk: write
Input
Output

prepare

checkout.prepare What is on sale for one event date — ticket types, availability, payment options and registration questions — and the payment_id the later steps need. Needs the event’s dateid, not its id. Risk: read
Input Output

Events

attendees

events.attendees Every attendee for one event with their barcode, ticket type, answers and check-in state. The route takes no paging parameters, so the whole list arrives at once. Risk: read
Input Output

get

events.get One event by its id. Answers an array even for a single id; an unknown id gives an empty array, not an error. Risk: read
Input Output

list

events.list The account’s events, paged with offset. Filter by status (only “live” is accepted) or category, and page with the returned next_offset. An empty account answers HTTP 200 with {“message”:“No events found”} rather than an array, which is read here as an empty page. Risk: read
Input Only status: live is accepted; every other value is rejected by the API. Set category to a name from categories.list. Output

transactions

events.transactions Paid and pending orders for one event, with buyer, amount and reference. Paged by offset; next_offset comes back on the result. Risk: read
Input Output

Orders

cancel

orders.cancel Cancel an order. The order and its tickets stop standing and the buyer is not restored by any other call; issuing a replacement means a new checkout. Risk: destructive · Irreversible
Input Output

confirm

orders.confirm Confirm an order after checkout. Emails the buyer unless sendemail is false. Confirming an already-confirmed order is the API’s own decision to make. Risk: write
Input Output

Sales

toggle

sales.toggle Open or close ticket sales for an event. Closing a sold-out event this way is reversible by toggling back. Risk: write
Input Output

Tickets

create

tickets.create Add a free ticket type to an event. Paid pricing is not part of this route: the reference documents it as free ticket types only. Risk: write
Input Output

list

tickets.list The ticket types on sale for one event, with price, quantity and sales window, plus any donation options. Risk: read
Input Output

update

tickets.update Change an existing free ticket type. Every field is required, because the API treats this as a full replace rather than a patch. Risk: write
Input Output

Transactions

get

transactions.get One order by checkout id or reference number. Verified live, this route does not filter: a small integer answers the account’s most recent transaction, a real checkout id answers “Unauthorized access”, and an unknown reference answers “Invalid reference number” (404). Check the returned refno before trusting it. Risk: read
Input Output

Users

get

users.get One organizer by id, in the same array envelope as the list. Risk: read
Input Output

list

users.list The organizer account and its sub-organizers, paged by offset. Risk: read
Input Output