GET

sims/school API

Retrieve and manage sims/school records from the Apps4Edu sync database.

Endpoint Path

GET /api/sims/school

CURL Example

curl "https://api.apps4education.co.uk/api/sims/school?api_token=YOUR_TOKEN&school=WONDE_SCHOOL_ID" \
-H "Accept: application/json"

Field Definitions

Field	Type
`school_id`	bigint
`id`	varchar
`name`	varchar
`establishment_number`	varchar
`urn`	varchar
`phase_of_education`	varchar
`la_code`	varchar
`timezone`	varchar
`mis`	varchar
`address_line_1`	varchar
`address_line_2`	varchar
`address_town`	varchar
`address_postcode`	varchar
`address_country`	varchar
`domain`	varchar
`has_timetables`	tinyint
`has_lesson_attendance`	tinyint
`allows_writeback`	tinyint
`created_at`	timestamp
`updated_at`	timestamp

Response Body (Sample)

{
  "data": [
    {
      "school_id": "example_value",
      "id": 101,
      "name": "example_value",
      "establishment_number": true,
      "urn": "example_value",
      "phase_of_education": "example_value",
      "la_code": "example_value",
      "timezone": "example_value",
      "mis": true,
      "address_line_1": "example_value",
      "address_line_2": "example_value",
      "address_town": "example_value",
      "address_postcode": "example_value",
      "address_country": "example_value",
      "domain": "example_value",
      "has_timetables": "example_value",
      "has_lesson_attendance": "example_value",
      "allows_writeback": "example_value",
      "created_at": "example_value",
      "updated_at": "example_value"
    }
  ]
}

Query Parameters

api_token

Required. Your unique API key must be passed as a query string parameter.

school

Required. The Wonde school ID; rows from other schools are never returned.

page

Optional. Defaults to 1. Used to navigate through paginated results.

per_page

Optional. Rows per page, up to 500 (the default). Follow next_page_url for the rest.