Skip to navigation
VOS APIPlayout Backend

Get list of events for a channel

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channelIdstringRequired
ID of the channel

Query parameters

RefEventIdstringOptional

Default is the Id of the rank #1 event, which is the on-air event (or next event if no on-air event)

EventOffsetintegerOptionalDefaults to 0
Signed integer. Applies to the Reference primary event, to identify the first returned event. Default is 0
EventsNumberintegerOptionalDefaults to 0

Number of returned events. Default is 0: returns the events until the end of the playlist

Response

OK
firstEventRankintegerOptional

The position of the first returned event in the playlist. The current on-air event has firstEventRank = 1

primarieslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error