Skip to navigation
EndpointsLive Sessions

Get Live Sessions

Return the live sessions of the organization, newest first.

The counters cover the whole calendar of the organization: total is every session in both timelines, while next_sessions_count and past_sessions_count say how many are in each one. results holds only the requested page of the requested status.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

statusenumOptionalDefaults to NEXT
NEXT returns the sessions that have not finished yet, PAST the ones already finished. Ask for both to walk the whole calendar
Allowed values:
firstintegerOptional1-100Defaults to 10

Page size (1-100)

pageintegerOptional>=1Defaults to 1
Page number, starting at 1
idslist of integersOptional

Return only these live session ids (up to 100, the same cap as the page size)

Response

Successful Response
totalinteger
Sessions of the organization in both timelines, not only the requested status
next_sessions_countinteger
Sessions that have not finished yet
past_sessions_countinteger
Sessions already finished
resultslist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error