Returns a paginated list of events with their occurrence and attendee counts. Use updatedSince to sync incrementally.
Archived and deleted events are excluded unless you ask for them explicitly with the status filter.
Events do not expose a duration: an event's length is determined by its sessions, so no meaningful single value exists at the event level.
HTTP Basic authentication using your Tenant ID and API secret.
- Username is the Tenant ID (i.e.
eu-west-2_AbcdEfghI) - Password is the API secret you would have received.
You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.
OAuth 2.0 client credentials authentication.
Use the following token endpoints (replace :tenantId with your Tenant ID):
Public API access tokens
- Staging:
https://public.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://public.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://public.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://public.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
Webhooks access tokens
- Staging:
https://user.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://user.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://user.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://user.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
All access tokens must be sent using the Authorization: Bearer <access_token> header.
Scopes
For API access (non-webhooks), the following scopes are available:
api/all– Full read and write access to the API.api/read– Read-only access to the API.api/write– Write access to the API.
For webhooks, the following scopes are available:
api/webhooks– Access to webhook functionality.api/all– Full read and write access to the API, including webhooks.
Tokens must include appropriate scopes for the endpoints you wish to call.
Page number for pagination
Number of records per page
Comma-separated list of lifecycle states to include. When omitted, archived events are excluded.
Returns only events whose metadata changed after this timestamp (title, description, status, occurrence and session edits).
Attendee activity does not update this timestamp: registrations, cancellations and attendance marking do not make an event appear in an updatedSince result. To track attendance state, read attendeeCount on the list or use GET /events/user/ref/{ref} per user.
A paginated list of events
Details of the pagination
Total number of results matching the query
Total number of pages available
Current page number
Number of results per page
Total occurrences on the event
Distinct users registered across all occurrences, excluding cancellations
Invalid status filter
An envelope containing information about the event errors
Unauthorized
Unauthorized
Unprocessable Content
Unprocessable Content