Returns a list of semesters

A semester groups a recurring set of classes that customers enrol into as a whole.

The id returned here is the stable identifier of the group. Individual classes report it as semesterId on GET /api/v2/host/sessions, so the two endpoints can be joined to attribute a class - or a sale made against one - to the semester it belongs to.

activeFrom and activeTo filter on overlap, not containment: a semester running January to June is returned for activeFrom=2021-03-01&activeTo=2021-03-31.

Query Params
integer
required
≥ 0

Starts at 0

integer
required
1 to 200
string
enum
Allowed:
string
enum

Field to sort by

Allowed:
date-time

only return semesters that are still running on or after this date

date-time

only return semesters that have started on or before this date

boolean

also include cancelled semesters

boolean

also include unpublished (draft) semesters

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json