GET

sims/students API

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

Endpoint Path

GET /api/sims/students

CURL Example

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

Field Definitions

Field	Type
`school_id`	bigint
`id`	varchar
`upi`	varchar
`mis_id`	varchar
`initials`	varchar
`title`	varchar
`surname`	varchar
`forename`	varchar
`middle_names`	varchar
`legal_surname`	varchar
`legal_forename`	varchar
`gender`	varchar
`date_of_birth`	datetime
`email`	varchar
`phone`	varchar
`restored_at`	datetime
`mis_created_at`	datetime
`mis_updated_at`	datetime
`created_at`	timestamp
`updated_at`	timestamp
`gender_identity`	varchar
`admission_number`	varchar
`upn`	varchar
`local_upn`	varchar
`former_upn`	varchar
`learner_number`	varchar
`current_nc_year`	varchar
`part_time`	tinyint
`part_time_rate`	varchar
`admission_date`	datetime
`leaving_date`	datetime

Response Body (Sample)

{
  "data": [
    {
      "school_id": "example_value",
      "id": 101,
      "upi": "example_value",
      "mis_id": true,
      "initials": "example_value",
      "title": "example_value",
      "surname": "example_value",
      "forename": "example_value",
      "middle_names": "example_value",
      "legal_surname": "example_value",
      "legal_forename": "example_value",
      "gender": "example_value",
      "date_of_birth": "example_value",
      "email": "example_value",
      "phone": "example_value",
      "restored_at": "example_value",
      "mis_created_at": true,
      "mis_updated_at": true,
      "created_at": "example_value",
      "updated_at": "example_value",
      "gender_identity": "example_value",
      "admission_number": true,
      "upn": "example_value",
      "local_upn": "example_value",
      "former_upn": "example_value",
      "learner_number": "example_value",
      "current_nc_year": "example_value",
      "part_time": "example_value",
      "part_time_rate": "example_value",
      "admission_date": true,
      "leaving_date": "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.