GET

staff API

Retrieve and manage staff records from the Apps4Edu sync database.

Endpoint Path

GET /api/staff

CURL Example

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

Field Definitions

Field	Type
`id`	bigint
`staffID`	int
`staffCode`	varchar
`firstName`	varchar
`middleName`	varchar
`lastName`	varchar
`legalFullName`	varchar
`preferredFullName`	varchar
`formerLastName`	varchar
`preferredFirstName`	varchar
`preferredLastName`	varchar
`alternativePreferredName`	varchar
`startDate`	datetime
`endDate`	datetime
`dateOfBirth`	datetime
`continuousServiceStartDate`	datetime
`localAuthorityStartDate`	datetime
`sex`	varchar
`bloodGroup`	varchar
`prefixDescription`	varchar
`title`	varchar
`nationalInsuranceNumber`	varchar
`dfesNumber`	varchar
`jobTitle`	varchar
`workEmail`	varchar
`schoolReferenceNumber`	varchar
`schoolUniqueReferenceNumber`	varchar
`extensionNo`	int
`payrollNumber`	varchar
`previousEmployerName`	varchar
`bankAccountNumber`	varchar
`bankAccountSortCode`	varchar
`doNotIncludeInCensus`	tinyint
`isSupplyStaff`	tinyint
`overseasTrainedTeacher`	tinyint
`considerAsFullTime`	tinyint
`declaredDisability`	varchar
`religiousAffiliationName`	varchar
`religiousAffiliationDescription`	varchar
`nationalInsuranceCategoryID`	int
`nationalInsuranceCategoryName`	varchar
`created_at`	timestamp
`updated_at`	timestamp

Response Body (Sample)

{
  "data": [
    {
      "id": 101,
      "staffID": 101,
      "staffCode": "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",
      "alternativePreferredName": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "dateOfBirth": "example_value",
      "continuousServiceStartDate": "example_value",
      "localAuthorityStartDate": "example_value",
      "sex": "example_value",
      "bloodGroup": "example_value",
      "prefixDescription": "example_value",
      "title": "example_value",
      "nationalInsuranceNumber": "example_value",
      "dfesNumber": "example_value",
      "jobTitle": "example_value",
      "workEmail": "example_value",
      "schoolReferenceNumber": "example_value",
      "schoolUniqueReferenceNumber": "example_value",
      "extensionNo": "example_value",
      "payrollNumber": "example_value",
      "previousEmployerName": "example_value",
      "bankAccountNumber": "example_value",
      "bankAccountSortCode": "example_value",
      "doNotIncludeInCensus": true,
      "isSupplyStaff": true,
      "overseasTrainedTeacher": "example_value",
      "considerAsFullTime": "example_value",
      "declaredDisability": true,
      "religiousAffiliationName": "example_value",
      "religiousAffiliationDescription": "example_value",
      "nationalInsuranceCategoryID": 101,
      "nationalInsuranceCategoryName": "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.