GET

behavioureventrecords API

Retrieve and manage behavioureventrecords records from the Apps4Edu sync database.

Endpoint Path

GET /api/behavioureventrecords

CURL Example

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

Field Definitions

Field	Type
`studentID`	int
`eventID`	int
`ownerID`	int
`classID`	int
`locationID`	int
`witness`	varchar
`witnessID`	int
`eventDate`	datetime
`adjustment`	int
`comment`	text
`processed`	tinyint
`subject`	text
`subjectID`	int
`department`	varchar
`departmentID`	int
`actioned`	int
`eventRecordID`	int
`dayOfWeek`	varchar
`timetableDay`	int
`weekDisplayName`	varchar
`weekNumber`	int
`reviewCompleted`	tinyint
`reviewDate`	datetime
`reviewedBy`	varchar
`reviewNotes`	text
`periodDisplayName`	varchar
`internalComment`	text
`instant`	datetime
`loggedBy`	varchar
`createdBy`	int
`owner`	varchar
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "studentID": 101,
      "eventID": 101,
      "ownerID": 101,
      "classID": 101,
      "locationID": 101,
      "witness": "example_value",
      "witnessID": 101,
      "eventDate": "example_value",
      "adjustment": "example_value",
      "comment": "example_value",
      "processed": "example_value",
      "subject": "example_value",
      "subjectID": 101,
      "department": "example_value",
      "departmentID": 101,
      "actioned": "example_value",
      "eventRecordID": 101,
      "dayOfWeek": "example_value",
      "timetableDay": "example_value",
      "weekDisplayName": true,
      "weekNumber": "example_value",
      "reviewCompleted": "example_value",
      "reviewDate": "example_value",
      "reviewedBy": "example_value",
      "reviewNotes": "example_value",
      "periodDisplayName": true,
      "internalComment": "example_value",
      "instant": "example_value",
      "loggedBy": "example_value",
      "createdBy": "example_value",
      "owner": "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.