Get authorized drivers

x-ms-visibility: "important"

Retrieve a paginated list of drivers authorized to operate the specified charger.

Path Parameters

chargerId string required

ID of the charger whose authorized drivers are to be retrieved.

Query Parameters

page int32

Page number to fetch. Default: 1.

limit int32

Number of records per page. Max value: 100. Default: 100.

search string

Search text to filter drivers.

sortKey string

Sort field to be used. Default: 'Name'

sortDescending boolean

Set to 'true' to sort descending based on sort key. Default: 'false'

Responses

• 200
• 400
• 401

---

Paginated list of authorized drivers for the specified charger.

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id int64
externalId string
name string
homeSiteId int64 nullable
payerId int64 nullable
homeSiteName string
tags object[]
Array [
id int64
idTag string
expiringDate date-time
startDate date-time nullable
lastUpdated date-time nullable
tokenName string
invoicable boolean nullable
driverId int64
]
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": 0,
      "externalId": "string",
      "name": "string",
      "homeSiteId": 0,
      "payerId": 0,
      "homeSiteName": "string",
      "tags": [
        {
          "id": 0,
          "idTag": "string",
          "expiringDate": "2025-02-17T11:24:21.324Z",
          "startDate": "2025-02-17T11:24:21.324Z",
          "lastUpdated": "2025-02-17T11:24:21.324Z",
          "tokenName": "string",
          "invoicable": true,
          "driverId": 0
        }
      ]
    }
  ]
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorised

Loading...