List

GET

/shipping/drivers/list/v1

GET

/shipping/drivers/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.drivers.listV1({
        filter_archived: true,
        filter_available_according_to_driver: true,
        filter_available_according_to_operators: true,
        filter_by_driver_id: "filter_by_driver_id",
        filter_status: [
            "unassigned",
        ],
        page: 1,
        page_size: 1,
        search: "search",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "org_id": "org_id",
      "schema_version": 1,
      "user_id": "user_id",
      "active_task_group_ids": [
        "active_task_group_ids"
      ],
      "archived_at_timestamp": "2024-01-15T09:30:00Z",
      "auto_assign_enabled": true,
      "available_according_to_driver": true,
      "available_according_to_operators": true,
      "email_address_primary": "email_address_primary",
      "email_address_secondary": "email_address_secondary",
      "first_name": "first_name",
      "last_name": "last_name",
      "last_seen_at_location": {
        "geometry": {
          "type": "GeometryCollection",
          "geometries": [
            {
              "type": "LineString",
              "coordinates": [
                []
              ]
            }
          ]
        },
        "type": "Feature"
      },
      "last_seen_at_location_city": "last_seen_at_location_city",
      "last_seen_at_location_large_city": "last_seen_at_location_large_city",
      "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
      "phone_number_primary": "phone_number_primary",
      "phone_number_secondary": "phone_number_secondary",
      "status": "unassigned",
      "vehicle_types": [
        "sedan"
      ],
      "waiting": true
    }
  ],
  "total_count": 1
}

Lists all drivers belonging to the caller’s organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query

filter_by_driver_idstringOptional

Filter by driver ID

filter_archivedbooleanOptionalDefaults to false

Select archived drivers instead of active drivers

filter_available_according_to_driverbooleanOptional

Filter by driver’s self-reported availability

filter_available_according_to_operatorsbooleanOptional

Filter by operator-set availability

filter_statusenumOptional

Filter by driver state (UNASSIGNED / ASSIGNED / IN_PROGRESS)

Allowed values:

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Drivers List V1request Unprocessable Entity Error