Skip to main content
GET
List Group

Authorizations

Authorization
string
header
required

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

Path Parameters

customerId
string
required

Response

200 - application/json;charset=UTF-8

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

id
string
required

ID of group

Required string length: 1 - 24
Pattern: ^[a-z0-9]+$
Example:

"groupID"

name
string

Group name

Maximum string length: 255
Example:

"group-name"

parentId
string

ID of parent group, in case for changing the hierarchy

Example:

"rootGroupId"

path
string
read-only

Hierarchy path from root group

Example:

"rootGroupId.groupID"

countDrivers
integer<int32>
read-only

Count of assigned drivers to group

Example:

1

countSecondaryDrivers
integer<int32>
read-only

Count of assigned secondary drivers to group

Example:

1

countSecondaryVehicles
integer<int32>
read-only

Count of assigned secondary vehicles to group

Example:

0

dataCleanupSettings
object

Data retention and cleanup configuration inherited or explicitly set for this group. A null value for any field indicates that the setting is unspecified at this level and will be inherited from the nearest ancestor group in the hierarchy that has a value defined, or from the customer-level data retention settings if no ancestor group specifies one. Fields must NOT be defaulted to 0 or false when unset, as those values carry distinct functional meaning.

countVehicles
integer<int32>
read-only

Count of assigned vehicles to group

Example:

0