GET

studentsiblings API

Retrieve and manage studentsiblings records from the Apps4Edu sync database.

Endpoint Path

GET /api/studentsiblings

CURL Example

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

Field Definitions

Field	Type
`studentSiblingID`	int
`studentID`	int
`siblingID`	int
`livesWith`	tinyint
`mailByHand`	tinyint
`startDate`	datetime
`endDate`	datetime
`yearGroup`	varchar
`tutorGroup`	varchar
`mailingPoint`	tinyint
`dateOfBirth`	datetime
`siblingPriority`	bigint
`legalFullName`	varchar
`lastName`	varchar
`middleName`	varchar
`firstName`	varchar
`prefixName`	varchar
`preferredFullName`	varchar
`preferredLastName`	varchar
`preferredFirstName`	varchar
`gender`	varchar
`upn`	varchar
`admissionNumber`	varchar
`siblingEnrolmentStartDate`	datetime
`siblingEnrolmentEndDate`	datetime
`uci`	varchar
`uln`	varchar
`examNumber`	varchar
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "studentSiblingID": 101,
      "studentID": 101,
      "siblingID": 101,
      "livesWith": "example_value",
      "mailByHand": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "yearGroup": "example_value",
      "tutorGroup": "example_value",
      "mailingPoint": "example_value",
      "dateOfBirth": "example_value",
      "siblingPriority": "example_value",
      "legalFullName": "example_value",
      "lastName": "example_value",
      "middleName": "example_value",
      "firstName": "example_value",
      "prefixName": "example_value",
      "preferredFullName": "example_value",
      "preferredLastName": "example_value",
      "preferredFirstName": "example_value",
      "gender": "example_value",
      "upn": "example_value",
      "admissionNumber": true,
      "siblingEnrolmentStartDate": "example_value",
      "siblingEnrolmentEndDate": "example_value",
      "uci": "example_value",
      "uln": "example_value",
      "examNumber": "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.