Skip to main content
GET
List sibling discount 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>

School UUID. Must be assigned to the authenticated session. Omit to use the operation's documented company/session scope.

status
enum<string>

Optional status filter, case-insensitive.

Available options:
active,
hold
sibling_filter
enum<string>

Optional sibling-family filter, case-insensitive.

Available options:
twins,
many_siblings
active_sibling_filter
enum<string>

Require all siblings to be active, case-insensitive.

Available options:
all_active
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>

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

Available options:
name_asc,
name_desc,
school_name_asc,
school_name_desc,
status_asc,
status_desc,
room_asc,
room_desc,
dob_asc,
dob_desc,
start_date_asc,
start_date_desc,
siblings_asc,
siblings_desc,
family_name_and_dob_asc,
family_name_and_dob_desc,
tuition_plan_asc,
tuition_plan_desc,
billing_cycle_asc,
billing_cycle_desc,
plan_status_asc,
plan_status_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.

school_id
string
required

School id.

school_name
string
required
student_id
string
required

Student id.

student_first_name
string
required
student_last_name
string
required
student_name
string
required
family_id
string
required

Family id.

status
string
required
dob
string
required
start_date
string
required
withdrawal_date
string
required
graduation_date
string
required
room
string
required
room_id
string
required

Room id.

ems_student_status
string
required
program
string
required
tuition_plan
string
required
billing_cycle
string
required
tuition_amount
number<double>
required
net_invoice
number<double>
required
plan_status
string
required
sibling_discount
string
required
sibling_discount_amount
number<double>
required
sibling_discount_pct
string
required
days_to_start_date
integer<int64>
required
parent1_name
string
required
siblings
string
required
twins
string
required
sibling_order
integer
required
sibling_twin
string
required
active_siblings_in_family
integer
required
staff_child
string
required
school_color_hex
string
required
school_short_name
string
required
has_birth_date_alert
boolean
required
has_sibling_discount_pct_alert
boolean
required
has_missing_sibling_discount_alert
boolean
required
has_unexpected_sibling_discount_alert
boolean
required
has_not_sibling_with_discount_alert
boolean
required