Skip to main content
GET
Get Driver Group
Returns the group and its drivers: each driver’s id, your externalIdentifier for them, their name, and whether they are enabled and on shift (isShiftActive). The path takes the group’s firstVersionContractId, the ID that stays the same however many times the group is edited.

Authorizations

Authorization
string
header
required

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

Path Parameters

first_version_contract_id
string
required

Response

OK

firstVersionContractId
string
required

Stable id of the driver group across versions.

displayName
string
required
isActive
boolean
required
providerId
string
required
drivers
DriverGroupMember · object[]
required

Drivers of your organization in this group.

externalIdentifier
string | null
unassignedDriverTimeoutMinutes
integer | null