GET

users API

Retrieve and manage users records from the Apps4Edu sync database.

Endpoint Path

GET /api/users

CURL Example

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

Field Definitions

Field	Type
`roleID`	int
`userID`	int
`firstName`	varchar
`lastName`	varchar
`legalFullName`	varchar
`preferredFirstName`	varchar
`preferredLastName`	varchar
`preferredFullName`	varchar
`loginName`	varchar
`sessionTimeOut`	int
`startDate`	datetime
`endDate`	datetime
`userStartDate`	datetime
`userEndDate`	datetime
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "roleID": 101,
      "userID": 101,
      "firstName": "example_value",
      "lastName": "example_value",
      "legalFullName": "example_value",
      "preferredFirstName": "example_value",
      "preferredLastName": "example_value",
      "preferredFullName": "example_value",
      "loginName": "example_value",
      "sessionTimeOut": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "userStartDate": "example_value",
      "userEndDate": "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.