GET

students API

Retrieve and manage students records from the Apps4Edu sync database.

Endpoint Path

GET /api/students

CURL Example

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

Field Definitions

Field	Type
`id`	bigint
`studentID`	int
`upn`	varchar
`admissionNumber`	varchar
`salutation`	varchar
`firstName`	varchar
`middleName`	varchar
`lastName`	varchar
`legalFullName`	varchar
`preferredFullName`	varchar
`formerLastName`	varchar
`preferredFirstName`	varchar
`preferredLastName`	varchar
`gender`	varchar
`bloodGroup`	varchar
`nhsNumber`	varchar
`ethnicity`	varchar
`nationality`	varchar
`prefix`	varchar
`honours`	varchar
`formerUPN`	varchar
`uci`	varchar
`uln`	varchar
`schoolUniqueReferenceNumber`	varchar
`examNumber`	varchar
`empty`	varchar
`yearGroup`	varchar
`tutorGroup`	varchar
`connexionsAgreementStateCode`	varchar
`connexionsAgreement`	varchar
`nCyearActual`	varchar
`familyStructureDescription`	varchar
`nationalCurriculumDescription`	varchar
`laInYearText`	varchar
`homeLA`	varchar
`recoupmentLA`	varchar
`twoYearOldFundTypeDescription`	varchar
`adoptedFromCareTypeName`	varchar
`adoptedFromCareTypeDescription`	varchar
`pupilPremiumFlag`	varchar
`everFSM6Flag`	varchar
`chronologicalYeargroup`	varchar
`thirtyHourCode`	varchar
`hasDisabilityLivingAllowance`	varchar
`hasFreeEarlyEducation`	varchar
`startDate`	datetime
`endDate`	datetime
`dateOfBirth`	datetime
`ethnicityID`	int
`photoFileName`	int
`giftedAndTalented`	int
`englishProficiencyDescription`	int
`yearGroupID`	int
`tutorGroupID`	int
`numberOfPositiveEvents`	int
`numberOfNegativeEvents`	int
`birthCertificateSeen`	tinyint
`isPregnantStudent`	tinyint
`isStudentPaidUniformAllowance`	tinyint
`inYear`	tinyint
`mailingPoint`	tinyint
`created_at`	timestamp
`updated_at`	timestamp

Response Body (Sample)

{
  "data": [
    {
      "id": 101,
      "studentID": 101,
      "upn": "example_value",
      "admissionNumber": true,
      "salutation": "example_value",
      "firstName": "example_value",
      "middleName": "example_value",
      "lastName": "example_value",
      "legalFullName": "example_value",
      "preferredFullName": "example_value",
      "formerLastName": "example_value",
      "preferredFirstName": "example_value",
      "preferredLastName": "example_value",
      "gender": "example_value",
      "bloodGroup": "example_value",
      "nhsNumber": "example_value",
      "ethnicity": "example_value",
      "nationality": "example_value",
      "prefix": "example_value",
      "honours": "example_value",
      "formerUPN": "example_value",
      "uci": "example_value",
      "uln": "example_value",
      "schoolUniqueReferenceNumber": "example_value",
      "examNumber": "example_value",
      "empty": "example_value",
      "yearGroup": "example_value",
      "tutorGroup": "example_value",
      "connexionsAgreementStateCode": "example_value",
      "connexionsAgreement": "example_value",
      "nCyearActual": "example_value",
      "familyStructureDescription": "example_value",
      "nationalCurriculumDescription": "example_value",
      "laInYearText": "example_value",
      "homeLA": "example_value",
      "recoupmentLA": "example_value",
      "twoYearOldFundTypeDescription": "example_value",
      "adoptedFromCareTypeName": "example_value",
      "adoptedFromCareTypeDescription": "example_value",
      "pupilPremiumFlag": "example_value",
      "everFSM6Flag": "example_value",
      "chronologicalYeargroup": "example_value",
      "thirtyHourCode": "example_value",
      "hasDisabilityLivingAllowance": true,
      "hasFreeEarlyEducation": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "dateOfBirth": "example_value",
      "ethnicityID": 101,
      "photoFileName": "example_value",
      "giftedAndTalented": "example_value",
      "englishProficiencyDescription": true,
      "yearGroupID": 101,
      "tutorGroupID": 101,
      "numberOfPositiveEvents": "example_value",
      "numberOfNegativeEvents": "example_value",
      "birthCertificateSeen": "example_value",
      "isPregnantStudent": true,
      "isStudentPaidUniformAllowance": true,
      "inYear": "example_value",
      "mailingPoint": "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.

page

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