GET

alerts API

Retrieve and manage alerts records from the Apps4Edu sync database.

Endpoint Path

GET /api/alerts

CURL Example

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

Field Definitions

Field	Type
`rowHash`	char
`raiserID`	int
`alertTypeDescription`	text
`location`	varchar
`startDate`	datetime
`endDate`	datetime
`comment`	text
`responseRequired`	tinyint
`reply`	varchar
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "rowHash": "example_value",
      "raiserID": 101,
      "alertTypeDescription": "example_value",
      "location": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "comment": "example_value",
      "responseRequired": "example_value",
      "reply": "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.