Skip to main content
GET
Get an event stream

Authorizations

Authorization
string
header
required

Path Parameters

eventStreamId
string
required

Response

Successful response

Stored event stream definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.

component_ids
string[]
required
created_date
string
required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$
Example:

"2025-10-24T09:00:00.000Z"

description
required

The description as configured: a literal value, or an expression (type:string) when defined dynamically.

filters
(APPLICATION_TYPE · object | EVENT_NAME · object | EVENT_TYPE · object | PERSON_ID · object | SANDBOX · object)[]
required
id
string
required
read-only
name
required

The name as configured: a literal value, or an expression (type:string) when defined dynamically.

stop_at
string
required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$
Example:

"2025-10-24T09:00:00.000Z"

tags
string[]
required
updated_date
string
required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$
Example:

"2025-10-24T09:00:00.000Z"