GET

syncstates API

Retrieve and manage syncstates records from the Apps4Edu sync database.

Endpoint Path

GET /api/syncstates

CURL Example

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

Field Definitions

Field	Type
`entity`	varchar
`watermark_at`	datetime
`last_run_at`	datetime
`last_success_at`	datetime
`status`	varchar
`rows`	int
`duration_seconds`	int
`message`	text
`created_at`	timestamp
`updated_at`	timestamp

Response Body (Sample)

{
  "data": [
    {
      "entity": "example_value",
      "watermark_at": "example_value",
      "last_run_at": "example_value",
      "last_success_at": "example_value",
      "status": "example_value",
      "rows": "example_value",
      "duration_seconds": "example_value",
      "message": "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.

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.