Get for caller

GET

/shipping/drivers/for_caller/v1

GET

/shipping/drivers/for_caller/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.drivers.getForCallerV1();
8 }
9 main();

200Retrieved

1 {
2   "schema_version": 1,
3   "_id": "_id",
4   "org_id": "org_id",
5   "user_id": "user_id",
6   "email_address_primary": "email_address_primary",
7   "email_address_secondary": "email_address_secondary",
8   "phone_number_primary": "phone_number_primary",
9   "phone_number_secondary": "phone_number_secondary",
10   "first_name": "first_name",
11   "last_name": "last_name",
12   "vehicle_types": [
13     "sedan"
14   ],
15   "status": "unassigned",
16   "available_according_to_driver": true,
17   "available_according_to_operators": true,
18   "waiting": true,
19   "auto_assign_enabled": true,
20   "active_task_group_ids": [
21     "active_task_group_ids"
22   ],
23   "last_seen_at_location": {
24     "type": "Feature",
25     "geometry": {
26       "type": "GeometryCollection",
27       "geometries": [
28         {
29           "type": "LineString",
30           "coordinates": [
31             []
32           ]
33         }
34       ]
35     },
36     "bbox": [
37       {
38         "key": "value"
39       }
40     ],
41     "properties": {
42       "address": "address",
43       "name": "name"
44     },
45     "id": 1
46   },
47   "last_seen_at_timestamp": "2024-01-15T09:30:00Z"
48 }

Retrieves driver information for the caller within their organization. | () -> (Driver1)

Authentication

AuthorizationBearer

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

Response

Successful Response

schema_versioninteger

_idstring

org_idstring

Must be a string starting with org_

user_idstring

Must be a string starting with user_

email_address_primarystringformat: "email"

email_address_secondarystringformat: "email"

phone_number_primarystring

phone_number_secondarystring

first_namestring

last_namestring

vehicle_typeslist of enums

statusenum

available_according_to_driverbooleanDefaults to true

available_according_to_operatorsbooleanDefaults to true

waitingbooleanDefaults to false

auto_assign_enabledbooleanDefaults to true

active_task_group_idslist of strings

last_seen_at_locationobject

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_timestampdatetime