GET

sims/employees API

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

Endpoint Path

GET /api/sims/employees

CURL Example

curl "https://api.apps4education.co.uk/api/sims/employees?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
`current`	tinyint
`teaching_staff`	tinyint
`teacher_number`	varchar
`teacher_category`	varchar
`staff_code`	varchar
`employment_start_date`	datetime
`employment_end_date`	datetime
`local_authority_start_date`	datetime
`employee_payroll_number`	varchar
`role_text`	varchar
`qualified_teacher_status`	varchar
`qualified_teacher_status_route`	varchar
`higher_level_teaching_assistant_status`	varchar

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",
      "current": "example_value",
      "teaching_staff": "example_value",
      "teacher_number": "example_value",
      "teacher_category": "example_value",
      "staff_code": "example_value",
      "employment_start_date": "example_value",
      "employment_end_date": "example_value",
      "local_authority_start_date": "example_value",
      "employee_payroll_number": "example_value",
      "role_text": "example_value",
      "qualified_teacher_status": "example_value",
      "qualified_teacher_status_route": "example_value",
      "higher_level_teaching_assistant_status": true
    }
  ]
}

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.