> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt > Use this file to discover all available pages before exploring further. # List events > Returns events accessible to the authenticated API key. Results are paginated: `page` (1–999, default 1) and `pageSize` (1–100, default 25) are honored, and the response wraps events in the standard `{ results, pagination }` envelope. Events are ordered oldest-first (`created_at` ascending, ties broken by `id`), so pages are stable across requests. By default each event is `id`, `name`, `timezone`, `starts_at`, `ends_at`, and `features`. Pass `expand` to attach extra collections. `expand=custom_fields` includes org-defined event custom field values (`CustomFieldValue[]`). An event with no values returns `[]`. Datetime custom field values are ISO 8601 in the event's local time with its UTC offset (for example `2026-08-15T09:00:00-03:00`); when the event has no valid timezone the raw UTC instant is returned (`2026-08-15T12:00:00.000Z`). Date-only (`date`) fields serialize as `M-DD-YYYY`: month without a leading zero, day with one, four-digit year (for example `9-22-2026` for 22 September 2026, `3-04-2026` for 4 March 2026). This is not ISO 8601; parse it with that exact pattern. `expand=integration_mappings` includes conference connector mappings (`EventIntegrationMapping[]`) from `Integration_Event_Mapping_Union` (Cvent, Grip, Swoogo, Swapcard, ASP, Stova, Bizzabo, Gleanin, ExpoPlatform, ON24). `source` is the union key (underscores, e.g. `expo_platform`). LiveBuzz / apps-engine campaign IDs are **not** included in this expand. Repeat the query param or comma-separate values: `?expand=custom_fields&expand=integration_mappings` ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/events openapi: 3.1.0 info: title: Sessionboard Public API version: '1.0' description: >- REST API for managing sessions, speakers, contacts, sponsors, exhibitors, and event data on the Sessionboard platform. contact: name: Sessionboard Support email: support@sessionboard.com termsOfService: https://www.sessionboard.com/legal/terms-of-service servers: - url: https://public-api.sessionboard.com description: US Region - url: https://public-api-eu.sessionboard.com description: EU Region security: - ApiKey: [] - BearerToken: [] tags: - name: Events description: Manage events on the platform. - name: Sessions description: Search and retrieve sessions within an event. - name: Session Writes description: >- Create, update, delete, and restore sessions. Requires the `write:sessions` scope. - name: Contact Writes description: >- Create, update, delete, and restore contacts. Requires the `write:contacts` scope. - name: Exhibitor Writes description: >- Create, update, delete, and restore exhibitors. Requires the `write:exhibitors` scope. - name: Sponsor Writes description: >- Create, update, delete, and restore sponsors. Requires the `write:sponsors` scope. - name: Field Writes description: >- Create, update, and delete custom fields. Requires the `write:fields` scope. - name: Speakers description: Search and retrieve speakers within an event. - name: Participants description: | Search and retrieve every contact holding a session role on an event — speakers, chairpersons, moderators and custom roles — with the roles each one holds, and list the event's participant roles. - name: Contacts description: Search and retrieve contacts at the organization or event level. - name: Sponsors description: Search and retrieve sponsors within an event. - name: Exhibitors description: Search and retrieve exhibitors within an event. - name: Event Settings description: >- Retrieve event configuration such as fields, tags, tracks, rooms, formats, levels, languages, and session statuses. - name: GDPR description: Manage GDPR data access and erasure requests. - name: Insights description: >- Query event data using SbQL, generate queries with AI, and manage dashboards. - name: Ask description: >- Ask a natural-language question about one event and get a cited answer. Requires the `read:ask` scope, granted explicitly. - name: Metadata Writes description: >- Create, update, and delete session metadata (rooms, tracks, tags, formats, levels, languages, statuses). Requires the `write:metadata` scope. - name: Agenda Planning description: >- Manage agenda drafts, draft sessions, scheduling rules, and evaluation personas. Requires the `write:events` scope. - name: Dashboards & Widgets description: >- Create, read, update, and delete dashboards and widgets at the event or organization level. Requires `write:events` scope for writes. - name: Reports & Queries description: >- Create, read, update, delete, and run saved SbQL queries/reports at the event or organization level. Requires `write:events` scope for writes. - name: Transcriptions description: >- Transcript text on sessions — fragments, summaries, insights, and translations. Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Session Recordings description: >- Session audio files for recording archives (live capture or imported audio). Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Media description: >- Upload video or audio files for automatic transcription. Requires `read:media` / `write:media` scopes. - name: Session Files description: > Documents attached to sessions (PDFs, PowerPoint, Word, images, and similar). Simple upload: `POST .../files/upload` (multipart, max 50 MB). Direct-to-storage: create → PUT → complete (max 500 MB). Requires `read:sessions` / `write:sessions` scopes. See the [Uploading session files](/guides/uploading-session-files) guide. - name: OAuth description: >- OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted at `/oauth/` (not `/v1/`). - name: Log Export description: > Pull your organization's API request, security and audit logs into a SIEM such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API token with the `read:audit_logs` scope, which can call nothing else. See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem) guide. - name: Awards description: >- Read and manage Awards programs and their categories, rounds, promo codes, submissions and reviews. Organization-level: paths start at `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards` scopes. - name: Registration description: > Registration inside Sessionboard: registration forms, ticket types, registrations, orders, attendees and check-ins for one event. Requires the preview scopes `read:registrations` / `write:registrations`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Registration turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. - name: Expo description: > Expo floor-map booths and sponsorship inventory for one event. Requires the preview scopes `read:expo` / `write:expo`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Expo turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. paths: /v1/events: get: tags: - Events summary: List events description: | Returns events accessible to the authenticated API key. Results are paginated: `page` (1–999, default 1) and `pageSize` (1–100, default 25) are honored, and the response wraps events in the standard `{ results, pagination }` envelope. Events are ordered oldest-first (`created_at` ascending, ties broken by `id`), so pages are stable across requests. By default each event is `id`, `name`, `timezone`, `starts_at`, `ends_at`, and `features`. Pass `expand` to attach extra collections. `expand=custom_fields` includes org-defined event custom field values (`CustomFieldValue[]`). An event with no values returns `[]`. Datetime custom field values are ISO 8601 in the event's local time with its UTC offset (for example `2026-08-15T09:00:00-03:00`); when the event has no valid timezone the raw UTC instant is returned (`2026-08-15T12:00:00.000Z`). Date-only (`date`) fields serialize as `M-DD-YYYY`: month without a leading zero, day with one, four-digit year (for example `9-22-2026` for 22 September 2026, `3-04-2026` for 4 March 2026). This is not ISO 8601; parse it with that exact pattern. `expand=integration_mappings` includes conference connector mappings (`EventIntegrationMapping[]`) from `Integration_Event_Mapping_Union` (Cvent, Grip, Swoogo, Swapcard, ASP, Stova, Bizzabo, Gleanin, ExpoPlatform, ON24). `source` is the union key (underscores, e.g. `expo_platform`). LiveBuzz / apps-engine campaign IDs are **not** included in this expand. Repeat the query param or comma-separate values: `?expand=custom_fields&expand=integration_mappings` operationId: list-events parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/ListEventsExpand' responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/Event' pagination: $ref: '#/components/schemas/Pagination' example: results: - id: 3960 name: Acme Conference timezone: America/Chicago starts_at: '2026-10-05T13:00:00.000Z' ends_at: '2026-10-07T22:00:00.000Z' features: primary_speakers: true speaker_acceptance: false translated_fields: false pagination: currentPage: 1 pageSize: 25 totalPages: 4 totalResults: 97 '401': description: Unauthorized components: parameters: Page: name: page in: query required: false schema: type: integer minimum: 1 maximum: 999 default: 1 description: Page number for pagination. PageSize: name: pageSize in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 description: | Number of results per page. The event-settings list endpoints (tags, tracks, levels, formats, rooms, languages, statuses) also accept the older spelling `page_size`, and used to accept only that — a request sending `pageSize` silently got the default 25. Both now work, `pageSize` wins when both are sent, and on these endpoints a value outside 1–100 is clamped rather than rejected. Everywhere else `pageSize` is the only spelling. ListEventsExpand: name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - custom_fields - integration_mappings description: > Extra collections on each event in `GET /v1/events`. Not the same enum as session `Expand` (`translated_fields`, `composition`, …). Repeat the parameter (`?expand=custom_fields&expand=integration_mappings`) or comma-separate (`?expand=custom_fields,integration_mappings`). - `custom_fields` — org-defined Event custom field values. Omitted from the payload when this expand is not requested. Present as `[]` when requested and the event has no values. - `integration_mappings` — `{ name, source, external_event_id }` rows from conference `Integration_*_Event_Mappings` (via the union view). `source` uses underscores (`expo_platform`, not `expo-platform`). LiveBuzz / apps-engine campaign IDs are not included. schemas: Event: type: object description: An event on the Sessionboard platform. properties: id: type: integer examples: - 3960 name: type: string examples: - Acme Conference timezone: type: string examples: - America/Chicago starts_at: type: string format: date-time nullable: true ends_at: type: string format: date-time nullable: true features: type: object properties: primary_speakers: type: boolean speaker_acceptance: type: boolean translated_fields: type: boolean custom_fields: type: array description: | Present only when `expand=custom_fields` is passed to `GET /v1/events`. Empty array when the event has no values. items: $ref: '#/components/schemas/CustomFieldValue' integration_mappings: type: array description: | Present only when `expand=integration_mappings` is passed to `GET /v1/events`. Conference connector event IDs only — LiveBuzz / apps-engine campaign IDs are not included. Empty array when none are mapped. items: $ref: '#/components/schemas/EventIntegrationMapping' Pagination: type: object description: >- Pagination metadata returned with POST search responses. The event-settings GET lists return the same numbers under snake_case keys — see `ListPagination`. properties: currentPage: type: integer examples: - 1 pageSize: type: integer examples: - 25 totalPages: type: integer examples: - 4 totalResults: type: integer examples: - 97 CustomFieldValue: type: object description: A custom field value attached to a record. properties: id: type: string name: type: string value: type: - string - boolean - 'null' description: | The formatted field value, or `null` when the field is empty. Numeric field types (`number`, `currency`, `percent`, `quantity`, `formula`) serialize a stored zero as its formatted value (for example `"0"`) — `null` means the field has no value, not that the value is zero. `checkbox` fields serialize as the strings `"Yes"` (checked) and `"No"` (explicitly unchecked); a checkbox that was never set is `null`. Writes take boolean `true` / `false`. `datetime` fields serialize as ISO 8601. On event custom fields (`GET /v1/events?expand=custom_fields`) the value is event-local time with the event's UTC offset (for example `2026-08-15T09:00:00-03:00`), falling back to the raw UTC instant (`2026-08-15T12:00:00.000Z`) when the event has no valid timezone. On session, speaker, sponsor, and exhibitor custom fields the value is the raw UTC instant. `date` (date-only) fields serialize as `M-DD-YYYY`: month without a leading zero, day with one, four-digit year (for example `9-22-2026` for 22 September 2026, `3-04-2026` for 4 March 2026). This is not ISO 8601; parse it with that exact pattern. type: type: string internal_name: type: string created_at: type: string EventIntegrationMapping: type: object description: A conference integration's identifier for this Sessionboard event. properties: name: type: string description: Display name (for example `Cvent`, `Grip`). examples: - Cvent source: type: string description: > Integration key from `Integration_Event_Mapping_Union` (table name minus `Integration_` / `_Event_Mappings`, lowercased). Multi-word vendors use underscores, e.g. `expo_platform`. examples: - cvent - expo_platform external_event_id: type: string description: Vendor event id, always a string. examples: - a1b2c3d4-e5f6-7890-abcd-ef1234567890 securitySchemes: ApiKey: type: apiKey in: header name: x-access-token description: >- Organization API token. Generate from Organization Settings → API Tokens. BearerToken: type: http scheme: bearer description: >- OAuth 2.1 access token. Obtained via the OAuth PKCE flow at `/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.