Skip to main content
GET
List waitlist entries

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.

query
string

Search text passed to the waitlist student lookup.

has_alerts
boolean
default:false

Return only entries with alerts when true; false leaves all entries eligible. Accepts true/1 and false/0, case-insensitive.

sort_by
enum<string>
default:name_asc

Sort by a supported column with an _asc or _desc suffix.

Available options:
name_asc,
name_desc,
school_name_asc,
school_name_desc,
preferred_start_date_asc,
preferred_start_date_desc,
preferred_start_date_last_update_asc,
preferred_start_date_last_update_desc,
age_preferred_start_date_asc,
age_preferred_start_date_desc,
admission_date_asc,
admission_date_desc,
lead_created_date_asc,
lead_created_date_desc,
dob_asc,
dob_desc,
siblings_asc,
siblings_desc
page
integer
default:1

One-based page number.

Required range: x >= 1
per_page
integer
default:100

Items per page; values greater than 500 are clamped to 500.

Required range: x >= 1

Response

Successful response.

student_id
string
required

Student id.

first_name
string
required
last_name
string
required
student_name
string
required
school_id
string
required

School id.

school_name
string
required
birth_date
string | null
required
current_age_months
number<double> | null
required
preferred_start_date
string | null
required
preferred_start_date_last_update
string | null
required
preferred_start_date_age_at
number<double> | null
required
preferred_start_date_is_past_date
boolean
required
period_if_room_is_elegible
object[] | null
required
row_has_elegible_room
boolean
required
joined_waitlist
string | null
required
siblings
string
required
has_alerts
boolean
required
is_intellikid_student
boolean
required
school_color_hex
string
required
school_short_name
string
required
procare_desktop_enrollment_status
string | null
required
procare_student_status
string
required