Skip to main content

Retrieve a single event by ID

Retrieve a single event by ID

Path Parameters
event_id uuid4 REQUIRED
Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object
event_id uuid

Event ID

title Title

Event title

description Description OPTIONAL

Event description

event_type EventType

Possible values: [in-person, online]

location Location OPTIONAL

Event location

timezone Timezone OPTIONAL

Event IANA timezone

utc_start_dt date-time

Event start date and time in UTC

utc_end_dt date-time

Event end date and time in UTC

is_recurring Is Recurring OPTIONAL

Indicates if the event is recurring

cover_image_key Cover Image Key OPTIONAL

Event cover image S3 key

cover_image_url Cover Image Url OPTIONAL

Event cover image URL

qr_code_url uri

Possible values: 1 ≤ length ≤ 2083

Event QR code URL

lifecycle_status EventLifecycleStatusV2

Possible values: [setup_required, upcoming, ready, live, finished]

finished_at Finished At OPTIONAL

Event completion time in UTC

access_code Access Code OPTIONAL

Event access code

input_languages string[] OPTIONAL

Event input languages (aggregated from channels)

output_languages string[] OPTIONAL

Event output languages (aggregated from channels)

target_languages string[] OPTIONAL

Organizer-configured default translation languages; pre-fills the language list when creating channels

listener_language_mode ListenerLanguageMode OPTIONAL

Possible values: [off, approval, auto]

utc_created_at date-time

Event creation time in UTC

utc_updated_at date-time

Event last update time in UTC

stages object[] OPTIONAL

Event stages with derived status and their channel refs (id + live runtime status)

stage_id uuid

Stage ID

event_id uuid

Parent event ID

name Name

Stage name

status StageStatus

Possible values: [setup_required, ready, live]

qr_code_url uri

Possible values: 1 ≤ length ≤ 2083

Stage QR code URL

greenscreen_settings Greenscreen Settings OPTIONAL

Stage caption rendering settings

utc_created_at date-time

Stage creation time in UTC

utc_updated_at date-time

Stage last update time in UTC

channels object[] OPTIONAL

Channels in the stage (lean ref: id, broadcast link, live runtime status)

channel_id uuid

Channel ID

broadcast_id Broadcast Id OPTIONAL

Underlying broadcast ID for direct streaming access

runtime_status OPTIONAL

Live runtime state of the channel's stream. null = stream not started or status not yet known (not an error). Eventually-consistent: can lag a few seconds behind the actual stream; 'errored' can be transient while a stream (re)starts, so debounce before surfacing an alert.

default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.