Skip to main content
GET
List enrollment series

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID.

view
enum<string>
default:basic

Select the representation.

Available options:
basic,
analytics,
trend
group_by
enum<string>
default:month

period implies period analytics unless view=trend.

Available options:
month,
period
period_from
string

First monthly period for monthly or trend views.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
period_to
string

Last monthly period for monthly or trend views.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
year_from
string
default:2023

First year for group_by=period; defaults to 2023.

Pattern: ^\d{4}$
year_to
string

Last year for group_by=period; defaults to the current year.

Pattern: ^\d{4}$

Response

Successful response.

Enrollment Monthly.

period
string
required
as_of_date
string
required
total_enrollment
integer
required