API reference
API reference
Every operation of the REST API v1, grouped as the workspace groups them. Each says the scopes it needs, the module it belongs to, its fields, what it answers and how it refuses, with a sample in your language and a Try it button.
Workspace
The key and the workspace it reaches.
Events
Events: list them, read one, create a draft, change its basics, publish it, and its numbers.
- GET
/eventsList events - POST
/eventsCreate a draft event - GET
/events/{eventId}Get an event - PATCH
/events/{eventId}Change an event - PUT
/events/{eventId}/statusPublish or unpublish an event - GET
/events/{eventId}/statsGet event statistics - GET
/events/{eventId}/questionsList registration questions - GET
/events/{eventId}/questions/schemaGet the answers schema
Tickets
Ticket types, add-ons and discount codes.
- GET
/events/{eventId}/ticket-typesList ticket types - GET
/events/{eventId}/ticket-types/{ticketTypeId}Get a ticket type - PATCH
/events/{eventId}/ticket-types/{ticketTypeId}Change a ticket type - GET
/events/{eventId}/add-onsList add-ons - GET
/events/{eventId}/discount-codesList discount codes - POST
/events/{eventId}/discount-codesCreate a discount code
Orders
Orders and their money, and the sales pace.
Attendees
Registrations and attendees, with their answers to the registration questions.
- GET
/events/{eventId}/attendeesList attendees - POST
/events/{eventId}/attendeesIssue free tickets - GET
/events/{eventId}/attendees/searchSearch attendees - GET
/events/{eventId}/attendees/{attendeeId}Get an attendee - POST
/events/{eventId}/registrationsRegister an attendee - POST
/events/{eventId}/attendees/{attendeeId}/cancelCancel a ticket
Check-in
Doors, door scans and checking people in.
Programme
Sessions, rooms, tracks and speakers.
- GET
/events/{eventId}/sessionsList sessions - POST
/events/{eventId}/sessionsAdd a session - GET
/events/{eventId}/sessions/{sessionId}Get a session - PATCH
/events/{eventId}/sessions/{sessionId}Change a session - GET
/events/{eventId}/roomsList rooms - GET
/events/{eventId}/tracksList tracks - GET
/events/{eventId}/speakersList speakers
Sponsors
Sponsors, exhibitors, their levels and their leads.
Call for speakers
Proposals sent to the call for speakers.
Crew
Crew, volunteers and shifts.
Surveys
Surveys and session ratings, counted. Never who answered what.
Finance
Invoices, credit notes and the budget summary.
Share kit
The share kit's leaderboard.
Communities
Communities and their members.
Webhooks
Webhook endpoints, their deliveries and the event types they can receive.
- GET
/webhooks/event-typesList webhook event types - GET
/webhooksList webhook endpoints - POST
/webhooksAdd a webhook endpoint - GET
/webhooks/{webhookId}Get a webhook endpoint - PATCH
/webhooks/{webhookId}Change a webhook endpoint - DELETE
/webhooks/{webhookId}Remove a webhook endpoint - POST
/webhooks/{webhookId}/secretMake a new signing secret - POST
/webhooks/{webhookId}/testSend a test message - GET
/webhooks/{webhookId}/deliveriesList deliveries
Automation
Subscriptions made by Power Automate, Zapier and other platforms that subscribe through the API.
The guides and this site are in your language. The API reference's own descriptions are in English, as the API itself speaks.