Skip to main content
GET
Get enrollment tracker

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. Must be assigned to the authenticated session.

room_id
string<uuid>

Optional room UUID.

period
string

Optional monthly period in YYYY-MM.

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

Response

Successful response.

Enrollment Tracker.

school_id
string
required

School id.

school_name
string
required
rooms
object[] | null
required