Skip to main content
GET
/
customer
/
{customerId}
/
group
List Group
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/group \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "groupID",
    "name": "group-name",
    "parentId": "rootGroupId",
    "path": "rootGroupId.groupID",
    "vehicleIds": [
      "vehicleID1",
      "vehicleID2"
    ],
    "personIds": [
      "personID1",
      "personID2"
    ],
    "countDrivers": 1,
    "countVehicles": 0,
    "countSecondaryDrivers": 1,
    "countSecondaryVehicles": 0
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json;charset=UTF-8

List of Groups visible to request context with counts of drivers and vehicles

​
id
string
required

Unique, unchangeable system generated identifier (alphanumeric) of the group.

Example:

"groupID"

​
name
string

Name of the group.

Example:

"group-name"

​
parentId
string

Unique, unchangeable system generated identifier (alphanumeric) for the parent of this group.
Not included for the root group in the hierarchy.

Example:

"rootGroupId"

​
path
string

List of the unique, unchangeable system generated identifiers (alphanumeric) for all the parent groups (starting from the root node) of this group, separated by full stops.
The list includes the identifier for this group.

Example:

"rootGroupId.groupID"

​
vehicleIds
string[]

Array of unique, unchangeable system generated identifiers (alphanumeric) for the vehicles assigned to this group.
Wil be an empty array for a newly created group.

Example:
["vehicleID1", "vehicleID2"]
​
personIds
string[]

Array of unique, unchangeable system generated identifiers (alphanumeric) for the drivers and web users assigned to this group.
Wil be an empty array for a newly created group.

Example:
["personID1", "personID2"]
​
countDrivers
integer

Count of the number of drivers in this group node.

Example:

1

​
countVehicles
integer

Count of the number of vehicles in this group node.

Example:

0

​
countSecondaryDrivers
integer

Count of assigned secondary drivers to group

Example:

1

​
countSecondaryVehicles
integer

Count of assigned secondary vehicles to group

Example:

0