Retrieve Assignments

Retrieve a list of all the driver assignments in a organization or subset of an organization.

SecuritybearerAuth
Request
query Parameters
vehicleIdentifier
string

Filter by vehicle identifier or VIN.

Example: vehicleIdentifier=5100DDDD-60B6-D7CD-3FA2-22CA712B0000
userIdentifier
string

Filter by user identifier or name.

Example: userIdentifier=5100CCCC-60B6-D7CD-3FA2-22CA712B0000
groupIdentifier
string

Filter by group identifier or name.

Example: groupIdentifier=5100BBBB-60B6-D7CD-3FA2-22CA712B0000
startDate
string <date-time>

Filter by start date.

Example: startDate=2023-09-10
endDate
string <date-time>

Filter by end date.

Example: endDate=2023-09-30
offset
integer

Record to start with.

Example: offset=1
limit
integer

Number of records to return.

Example: limit=100
order
string

Sort direction.

Example: order=asc
sort
string

Name of property to sort on.

Example: sort=SerialNumber
includeSubgroups
boolean

Include subgroups.

Example: includeSubgroups=false
Responses
200

Ok

204

No Content: HTTP request has been successfully completed, and there is no message body

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

get/v1/driver-assignments
Request samples 
Response samples 
application/json
{
  • "metadata": {
    },
  • "data": [
    ]
}
© 2023 Lytx, Inc. All rights reserved