GET

series API

Retrieve and manage series records from the Apps4Edu sync database.

Endpoint Path

GET /api/series

CURL Example

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

Field Definitions

Field	Type
`seriesID`	int
`seriesName`	varchar
`seriesCode`	varchar
`seasonID`	int
`boardID`	int
`startDate`	datetime
`endDate`	datetime
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "seriesID": 101,
      "seriesName": "example_value",
      "seriesCode": "example_value",
      "seasonID": 101,
      "boardID": 101,
      "startDate": "example_value",
      "endDate": "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.