GET

studentenrolments API

Retrieve and manage studentenrolments records from the Apps4Edu sync database.

Endpoint Path

GET /api/studentenrolments

CURL Example

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

Field Definitions

Field	Type
`studentID`	int
`lastSchoolName`	varchar
`previousSchool`	varchar
`dateOfEntry`	datetime
`enrolmentStatusName`	varchar
`enrolmentStatusDescription`	text
`hasEverLeft`	int
`isLeaver`	int
`dateOfLeaving`	datetime
`leavingReasonCode`	text
`leavingReasonDescription`	text
`additionalLeavingReasonCode`	text
`additionalLeavingReasonDescription`	text
`destinationSchoolName`	varchar
`enrolmentStartDate`	datetime
`enrolmentEndDate`	datetime
`otherSchoolName`	varchar
`censusEnrolmentStatusName`	varchar
`censusEnrolmentStatusDescription`	text
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "studentID": 101,
      "lastSchoolName": "example_value",
      "previousSchool": "example_value",
      "dateOfEntry": "example_value",
      "enrolmentStatusName": "example_value",
      "enrolmentStatusDescription": "example_value",
      "hasEverLeft": "example_value",
      "isLeaver": true,
      "dateOfLeaving": "example_value",
      "leavingReasonCode": "example_value",
      "leavingReasonDescription": "example_value",
      "additionalLeavingReasonCode": "example_value",
      "additionalLeavingReasonDescription": "example_value",
      "destinationSchoolName": "example_value",
      "enrolmentStartDate": "example_value",
      "enrolmentEndDate": "example_value",
      "otherSchoolName": "example_value",
      "censusEnrolmentStatusName": "example_value",
      "censusEnrolmentStatusDescription": "example_value",
      "created_at": "example_value",
      "updated_at": "example_value",
      "school_id": "example_value"
    }
  ]
}

Query Parameters

api_token

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

school

Optional. A Bromcom school ID to restrict rows to one school.

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.