API Get Schools

Get Schools

Returns schools for the client associated with the fair. Optionally include preloaded/system schools.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field	Required	Description
ApiKey	Yes	Private API key for your site.
FairId	Yes	Fair GUID from the site URL (f query parameter).
Body	Depends	Request payload. Use {} when no body fields are needed.

Calls must be run server-side — do not expose your API key in a browser.

Response envelope

Most endpoints return:

{
  Success: true,
  Message: null,   // error text when Success is false
  Body: { ... }    // endpoint-specific payload
}

Request

fetch('/api/data/schools', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
            Body: {
				includePreloadedSchools: false  // optional, default false
			}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success Body looks like:

{
  Success: true,
  Message: null,
  Body: {
    schools: [{
      id: 24,
      name: "Example School",
      address: "100 School Rd",
      address2: null,
      city: "Ogden",
      state: "UT",
      zip: "84401",
      phone: "801-555-0100",
      SchoolType: "Public School",
      PrincipalName: "Pat Principal",
      PrincipalPhone: "801-555-0101",
      PrincipalEmail: "principal@example.edu",
      DistrictName: "Example District",
      DistrictId: 5
    }]
  }
}

Field notes

• Set Body.includePreloadedSchools to true to include preloaded schools in addition to client schools.
• School id values are used when adding projects/participants (SchoolId).
• To create or update a school, see API Add School.

Related APIs

• API Add School
• API Get Teachers
• API Add Project / API Get Projects