Skip to main content
GET
/
v1
/
Scheduling
/
drivers
Get Drivers
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/drivers \
  --header 'Authorization: <api-key>'
[
  {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "DistributorId": 123,
    "OperatorId": 123,
    "OperatorName": "<string>",
    "UserId": 123,
    "FullName": "<string>",
    "Mobile": "<string>",
    "Email": "<string>",
    "DriverLicense": "<string>",
    "IdNumber": "<string>",
    "Img": "<string>",
    "DriverStatusId": 123,
    "StartDate": "<string>",
    "Skills": [
      123
    ],
    "WorkingHours": "<string>",
    "CreatedBy": 123,
    "CreatedDt": "2023-11-07T05:31:56Z",
    "UpdatedBy": 123,
    "UpdatedDt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

​
ActorId
integer<int64>

The unique identifier of the actor associated with the drivers.

​
DriverStatusId
integer<int32>

The status identifier of the drivers to filter the results.

​
Search
string

A search string used to find drivers based on various fields.

​
SearchByDriverId
boolean
default:false

Indicates whether to search by DriverId.

​
SearchByUserId
boolean
default:false

Indicates whether to search by UserId.

​
SearchByFullname
boolean
default:false

Indicates whether to search by the driver's fullname.

​
SearchByMobile
boolean
default:false

Indicates whether to search by the driver's mobile number.

​
SearchByEmail
boolean
default:false

Indicates whether to search by the driver's email address.

​
SearchByIdNumber
boolean
default:false

Indicates whether to search by the driver's identification number.

​
SearchByDriverLicense
boolean
default:false

Indicates whether to search by the driver's license number.

Response

200 - application/json

A list of drivers that match the specified criteria.

​
Id
string<uuid>

The unique identifier of the driver.

​
DistributorId
integer<int64>

The unique identifier of the distributor associated with the driver.

​
OperatorId
integer<int64>

The unique identifier of the operator associated with the driver.

​
OperatorName
string | null

The name of the operator associated with the driver.

​
UserId
integer<int64>

The unique identifier of the user associated with the driver.

​
FullName
string | null

The full name of the driver.

​
Mobile
string | null

The mobile phone number of the driver.

​
Email
string | null

The email address of the driver.

​
DriverLicense
string | null

The driver's license number of the driver.

​
IdNumber
string | null

The identification number of the driver.

​
Img
string | null

The URL to the driver's image.

​
DriverStatusId
integer<int32> | null

The status identifier of the driver, indicating their current status.

​
StartDate
string | null

The date when the driver started working.

​
Skills
integer<int32>[] | null

A list of skill identifiers associated with the driver.

​
WorkingHours
string | null

The working hours of the driver.

​
CreatedBy
integer<int64>

The identifier of the user who created the driver entry.

​
CreatedDt
string<date-time>

The date and time when the driver entry was created.

​
UpdatedBy
integer<int64> | null

The identifier of the user who last updated the driver entry.

​
UpdatedDt
string<date-time> | null

The date and time when the driver entry was last updated.