List event sessions

List all the sessions of an event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

This endpoint requires the events:read or events:write scopes.

This endpoint can be used to list down all past and future Sessions of a given Event. Here are the filters that can be used:

filter[status]

You can filter the event's sessions by their status, which can be one of these items

  • upcoming: all upcoming sessions for this event
  • live: all live sessions
  • on_demand: all ongoing on-demand sessions
  • past: all past sessions, e.g those which already took place
  • past_not_started: all past sessions which never started
  • canceled: all canceled sessions
  • draft: all draft sessions

filter[date_from] and filter[date_from]

These two filters can be used to only select sessions' which estimated_started_at attribute started before or after the specified date. The chosen date can either be a UNIX timestamp or an ISO-8601 date.

include

Finally, you can choose to add related children objects to the returned payload, including the actual Event and the list of People of each session.

❗️

Warning on 'include' statements

Be cautious about the include statement. If you include the people related to each session, the returned payload can be quite large, thus leading to high response times from the API, and might even time out if there are too many participants!

→ If you need to fetch the full list of participants for large events, please use the GET /sessions/{id}/people endpoint instead, which is paginated.

Path Params
string
required

Event ID

Query Params
string

Page index to be returned

string

Number of record to be returned by page

string

Filter Sessions by status : 'upcoming', 'live', 'on_demand', 'past', 'past_not_started', 'canceled', 'draft'

string

Filter Sessions which ‘estimated_started_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions which ‘estimated_started_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).

string

Filter Sessions depending upon if they are breakout room sessions or not

include
array of strings

Include Related Data

include
Allowed:
Responses

401

Authentication failed

403

Workspace blocked

404

Event Not found

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json
*/*