Skip to main content
This reference documents every endpoint available in the Sessionboard Public API. Endpoint pages are generated from our OpenAPI specification and include request parameters, response schemas, and example payloads.

​
Base URLs

Use the base URL corresponding to the region where your organization’s data is hosted.

​
Authentication

All requests require an x-access-token header containing a valid API token. See Authentication for details on generating and managing tokens.

​
Common Patterns

​
Pagination

Search endpoints accept page and pageSize parameters and return a pagination object in the response. The default page size is 25 and the maximum is 100. Session responses include is_abstract and composition_status for composition-aware integrations. Subsessions inherit these fields from their parent. See Sessions & composition for filters, expand options, and contact session summaries.

​
Filtering

POST-based search endpoints accept filter criteria in the request body. Refer to each endpoint’s documentation for available filter fields.

​
Create vs Search Endpoints

Some resources have two POST endpoints at similar paths: The /create suffix distinguishes write operations from search where both use POST on the same collection path (sessions, contacts, exhibitors, sponsors, custom fields, and metadata entities). Session-scoped transcriptions, recordings, and session files use standard REST — POST on the collection path creates a resource; there is no conflicting search endpoint. See Media & Transcriptions and Uploading session files for upload flows.

​
Sorting

POST-based search endpoints accept a sort object in the request body to control result ordering. Sort by createdAt or updatedAt with asc or desc direction.

​
Expanding Records

Some endpoints support an expand query parameter (or request-body field) to include additional data in the response.

​
Nested session metadata

Session responses embed assigned metadata as nested objects: Unassigned metadata is returned as an empty object {} on POST /v1/event/{eventId}/sessions (search). CRUD proxy endpoints (GET list, create, update, restore) return null instead.

​
Subsessions

Sessions can have subsessions (child sessions linked to a parent). Subsessions are returned both:
  • Nested, inside parent.subsessions[] on every session response. The default shape is minimal — pass expand=subsession_details to receive full parity with the parent session.
  • Top-level, by calling GET /v1/event/{eventId}/sessions/{sessionId} with the subsession’s UUID directly. The endpoint always returns the full session shape (including chairpersons, moderators, custom_fields, etc.) plus parent_session_friendly_id and parent_session_friendly_id_raw keys identifying the parent. The expand=subsession_details flag has no effect at the top level.
This means callers can iterate parent.subsessions[], take each subsession id, and call the GET endpoint to retrieve the same shape they would for a parent session — useful for integration patterns that need to walk the session tree.

​
Session participants (Sessions 2.0)

Session responses include both legacy role arrays and a flat participants array: Each participant object uses the SessionSpeaker contact profile shape plus participant_role (slug, name, name_plural, core_role). Use participant_role.name (or slug) as the display/program role — for example Author or Panelist. core_role is only the legacy junction mapping (speaker, chairperson, moderator) and is not the role label. Contact profile fields on embedded participants — photo_url, company_name, title, address_country, and other standard contact fields — are included in the event’s default language without expand. Use expand=translated_fields for other locales. Legacy speakers / chairpersons / moderators entries also include participant_role when the event has Sessions 2.0 roles configured.

​
Organization-Scoped vs Convenience Routes

Dashboards, widgets, and saved reports support three route patterns: The convenience routes are recommended for org-level operations — they’re simpler and don’t require you to know the org ID. The org-scoped routes (/v1/organization/{orgId}/...) are equivalent but require the org ID in the URL.

​
Media & Transcriptions

Sessionboard exposes three related but distinct media workflows. Pick the path that matches what you have: Start with the Media & Transcriptions guide for playbooks and examples, or the API overview for resource shapes. Endpoint pages are grouped under Event — Media in the sidebar.

​
Error Codes