List users

GET

/users

Request

Query Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠429429 Too many requests

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/users?createdByType=undefined&createdByID=undefined&createdOnDateTime=undefined&lastUpdatedOnDateTime=undefined&limit=undefined&after=undefined&before=undefined&deleted=undefined'

Response Example

200 - Example 1

{
    "id": 0,
    "createdByUser": "string",
    "createdOnDateTime": "string",
    "lastUpdatedOnDateTime": "string",
    "status": "string",
    "lastLoggedInOnWeb": "string",
    "firstName": "string",
    "lastName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "town": "string",
    "province": "string",
    "provinceID": 0,
    "postcode": "string",
    "landline": "string",
    "mobile": "string",
    "appearOnSchedule": true,
    "skills": [
        {
            "id": 0,
            "skill": "string"
        }
    ],
    "shift": "string",
    "shiftID": 0,
    "publicHolidayGroups": [
        {
            "id": "string",
            "publicHolidayGroup": "string"
        }
    ]
}

Modified at 2026-09-18 12:33:00

Mark as aborted

List titles