You authenticate to the API with an HTTP Bearer token. Create one inside the AEvent app:

Use that token wherever the examples below show <YOUR_API_TOKEN>. Treat it like a password: anyone who has it can read your account data, so store it in a secret manager and never commit it to code or share it in a screenshot.

Your account has a complete, always-current API reference built in. In Settings, Developer, open the Endpoints tab. It lists every endpoint with its parameters and response shape, and it is generated directly from the live API, so it never drifts out of date.

The Try It button on any endpoint runs a real call against your account, right there in the page, already signed in as you. It is the fastest way to see exactly what an endpoint returns before you write any code.

A few things to know that apply to every call:

Here is the simplest possible call. It asks for one registrant so you can confirm your token works:

If your token is valid you get back a JSON object. If it is missing, malformed, or expired, the API returns a 401:

Seeing this 401 means the token is the problem. Re-check Step 1: a valid token, the Bearer prefix present, and no stray whitespace.

These examples are read-only GET calls. You can paste each one into your terminal after swapping in your own token and IDs. Replace the sample campaign ID, webinar ID, and registrant ID with real ones from your account (the calls themselves show you where to find them).

Pass a campaign ID (wtl) to get everyone who registered for it. Each registrant includes an attendance object, so this one call tells you both who signed up and who showed up.

Where to get the campaign ID: it is the 15-character wtl in your campaign URL, or the webinarTimeline value returned by the webinars call below.

The attendance object on every registrant is how you tell attendees from non-attendees. There is no attended=true filter on the list; instead you read it off each record:

So to count attendees, pull the registrant list for the campaign and keep the records whose attendance.attendance is greater than 0 (or whose groups contains Attendee).

Pass a registrant ID to get that person's full record, including their join and replay links, the integrations they were synced to, and their attendance. The ID is the uuid from the list call above.

List your webinars with their registrant and attendance numbers. Use type=past for completed webinars, type=upcoming for scheduled ones. Results are grouped by webinar.

Here registrants and attendees are counts, and attendance is the show-up rate for that webinar.

Pass a webinar ID (the webinarID from the call above) to get that webinar's full record, including its schedule, tracks, and live status fields.

The full response is large and includes the campaign settings, tracks, and status blocks. Use the Endpoints, Try It button to browse the complete shape for your own webinar.

List your recurring and evergreen webinars (the underlying schedules, as opposed to individual occurrences).

The registrants list supports filtering, sorting, and paging. Combine the query parameters to get exactly the slice you want. For example, the 25 most recent registrations:

The parameters you can use:

The API is not read-only. You can add registrants, manage your ban list, and send webinar chat messages. Writes change real data, so build them carefully and test each one with the Endpoints, Try It button before you automate it. Every write also validates its input: send a request with a missing field and the API tells you exactly what it needs, for example a call to POST /api/messages with no body returns 422 { "message": "The message field is required." }.

These calls need a write scope on your token (for example registrants.write or webinars.write), so add those scopes in Step 1 if you plan to make changes.

Register someone for a campaign with POST /api-registration (shown as Register for a webinar in your Endpoints reference). This endpoint authenticates with your account's Registration secret rather than the API token: the secret is displayed on that endpoint in the Endpoints tab and is meant to live on your server. Required fields are secret, wtl (the campaign), and email; you can also send firstName, lastName, phone, webinarid (a specific session), location, ipAddress, and country. AEvent registers the person and returns a success response.

For a public web registration form, use the hosted /registration page instead of calling this directly. To change someone who already exists, send updated fields to PUT /api/registrants/{uniqueID} using your API token and the numeric uniqueID from the registrants list.

Ban an email so it can no longer register, or lift a ban. Both endpoints accept a single email or an emails array, and return 201. Omitting the email returns 422 { "message": "At least one email is required." }.

To lift the ban, send the same body to /api/registrants/unban.

Send a chat message into a live webinar. message and webinarID are required. Add registrantID or email to message one specific person, or inReplyTo to answer a specific message from a registrant. A successful send returns 200. This is the endpoint that powers two-way chat bots and AI agents.

The webinar must be live for the message to appear. There is also POST /api/webinar/create (requires timestamp and webinarTimeline) and POST /api/webinar/delete (requires webinarID) for managing webinars; browse the Endpoints tab for their full request shapes.