Skip to main content
GET
List schools

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_ids
string<uuid>[]

Restrict to these school UUIDs. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

only_active
boolean
default:false

Return active schools only. Only true/1 enables the filter; other values disable it.

Response

Successful response.

id
string
required
name
string
required
capacity
integer<int64>
required
full_name
string
required
gusto_company_uuid
string | null
required
gusto_company_id
string | null
required
company_id
string
required

Company id.

street_address
string | null
required
city
string | null
required
state
string | null
required
zip
string | null
required
phone
string | null
required
time_zone
string | null
required
inquiry_call_pre_screen
boolean
required
is_active
boolean
required
is_procare_online
boolean
required
is_procare_online_leads
boolean
required
procare_desktop_id
string | null
required
procare_desktop_name
string | null
required
hide_billing_plan_alerts
boolean
required
intellikid_location_id
string | null
required
IsIntellikidSchoolWithNoLeadsInProcare
boolean
required

The API currently serializes this property with the exact capitalization shown.

lineleader_center_id
integer | null
required
lineleader_center_name
string | null
required
lineleader_center_code
string | null
required