GET

sims/classes API

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

Endpoint Path

GET /api/sims/classes

CURL Example

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

Field Definitions

Field	Type
`school_id`	bigint
`id`	varchar
`mis_id`	varchar
`type`	varchar
`name`	varchar
`code`	varchar
`description`	varchar
`subject`	varchar
`alternative`	tinyint
`priority`	tinyint
`academic_year`	int
`year_group`	varchar
`restored_at`	datetime
`mis_created_at`	datetime
`mis_updated_at`	datetime
`created_at`	timestamp
`updated_at`	timestamp

Response Body (Sample)

{
  "data": [
    {
      "school_id": "example_value",
      "id": 101,
      "mis_id": true,
      "type": "example_value",
      "name": "example_value",
      "code": "example_value",
      "description": "example_value",
      "subject": "example_value",
      "alternative": "example_value",
      "priority": "example_value",
      "academic_year": "example_value",
      "year_group": "example_value",
      "restored_at": "example_value",
      "mis_created_at": true,
      "mis_updated_at": true,
      "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.