Get

GET

/shipping/drivers/v1/:driver_id

GET

/shipping/drivers/v1/:driver_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.drivers.getByDriverIdV1("driver_id");
}
main();

{
  "_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",
    "bbox": [
      {
        "key": "value"
      }
    ],
    "id": 1,
    "properties": {
      "address": "address",
      "name": "name"
    }
  },
  "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
}

Retrieves detailed driver information by driver ID within the organization. | () -> (DriverWithActiveTaskGroupIds1)

Authentication

AuthorizationBearer

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

Path parameters

driver_idstringRequired

Response

Successful Response

_idstring

org_idstring

Must be a string starting with org_

schema_versioninteger

user_idstring

Must be a string starting with user_

active_task_group_idslist of stringsOptional

archived_at_timestampdatetimeOptional

auto_assign_enabledbooleanOptionalDefaults to true

available_according_to_driverbooleanOptionalDefaults to true

available_according_to_operatorsbooleanOptionalDefaults to true

email_address_primarystringOptionalformat: "email"

email_address_secondarystringOptionalformat: "email"

first_namestringOptional

last_namestringOptional

last_seen_at_locationobjectOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

last_seen_at_location_citystringOptional

last_seen_at_location_large_citystringOptional

last_seen_at_timestampdatetimeOptional

phone_number_primarystringOptional

phone_number_secondarystringOptional

statusenumOptional

vehicle_typeslist of enumsOptional

waitingbooleanOptionalDefaults to false

Errors

422

Drivers Get by Driver ID V1request Unprocessable Entity Error