List user groups

GET

/settings/userGroups

A user group is a reporting line that allows businesses to group technicians, visually split the schedule and report on opportunities and jobs. Examples of user groups include 'North' vs 'South'.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

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 '/settings/userGroups' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": 0,
            "createdOnDateTime": "string",
            "lastUpdatedOnDateTime": "string",
            "userGroup": "string"
        }
    ]
}

Modified at 2026-09-16 07:48:38

List business units

List provinces