Admin - Schools

List Schools

Changed on

List schools with optional filtering. Only accessible by admin users.

get/admin/schools

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/schools
  • Auth: OAuth 2 (password, token URL api/login)

Query parameters

searchstring nullable

Search by school name or domain

Response

Successful Response

idstring required
namestring required
email_domainstring nullable
uaistring nullable
french_school_idstring nullable
french_school_namestring nullable
contact_emailstring email nullable
contact_namestring nullable
phone_numberstring nullable
addressstring nullable
citystring nullable
contract_type'free' | 'pilot' | 'paid' | 'expired' required
contract_start_datestring date-time nullable
contract_end_datestring date-time nullable
max_teachersinteger nullable
max_studentsinteger nullable
notesstring nullable
expected_teachersstring[]
created_bystring required
created_atstring date-time required
updated_atstring date-time required
current_contract_idstring nullable
current_contract_status'active' | 'upcoming' | 'ended' nullable
attio_company_idstring nullable
attio_web_urlstring nullable
logo_data_urlstring nullable
teacher_countinteger

Changes