Retrieve list of drivers

Retrieve a list of all the drivers in an organization.

Request
Security:
bearerAuth
query Parameters
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the organization. Obtain this from GET /organizations.

Example: organizationId=17
driverFirstName
string

Filter by first name of the driver (regex case-insensitive).

driverLastName
string

Filter by last name of the driver (regex case-insensitive).

driverId
string (driverId)

The unique ID of the driver. The ID is generated automatically by the Surfsight system when creating the driver in an organization. This is not the driver code that is used for assigning to devices. Obtain this from GET /drivers.

Example: driverId=qwerty12345
driverThirdPartyId
string (driverThirdPartyId)

Filter by the driver's third party ID. Obtain this ID from GET /drivers.

Example: driverThirdPartyId=moshe123
driverIsActive
boolean

Filter by active or inactive state of the driver.

sort
string (Sort)
Default: "createdAt"

Sort the list of drivers.

Enum: "createdAt" "drivingLicense" "firstName" "lastName"
order
string (Order)
Default: "desc"

Set the order that pagination results appear in - ascending or descending order.

Enum: "asc" "desc"
offset
string^[1-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/drivers
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/drivers?organizationId=17&driverFirstName=string&driverLastName=string&driverId=qwerty12345&driverThirdPartyId=moshe123&driverIsActive=true&sort=createdAt&order=asc&offset=1&limit=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ]
}