List

GET

/tracking_integrations/tive/devices/list/v1

GET

/tracking_integrations/tive/devices/list/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.trackingIntegrations.tive.devices.listV1({
8         sort_by: "chrt_created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_tive_account_id: 1,
13         filter_tive_device_id: "filter_tive_device_id",
14         filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
15         filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16     });
17 }
18 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "5f8d0d55b54764421b7156c3",
6       "org_id": "org_9a8b7c6d5e4f3g2h1i0j",
7       "tive_account_id": 123456,
8       "tive_account_name": "Global Logistics Inc.",
9       "tive_device_id": "device_7890abcd1234efgh",
10       "tive_device_name": "Tive Tracker Alpha",
11       "chrt_created_at_timestamp": "2024-04-10T14:22:00Z",
12       "chrt_updated_at_timestamp": "2024-04-15T08:45:00Z",
13       "tive_current_shipment_id": "shipment_4567xyz890",
14       "tive_current_public_shipment_id": "public_shipment_4567xyz890"
15     }
16   ],
17   "total_count": 1
18 }

Lists Tive devices with filtering, sorting, and pagination. Scoped to the caller’s organization. | authz: min_org_role=operator | () -> (TiveDeviceListRes)

List

GET

/tracking_integrations/tive/devices/list/v1

GET

/tracking_integrations/tive/devices/list/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.trackingIntegrations.tive.devices.listV1({
8         sort_by: "chrt_created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_tive_account_id: 1,
13         filter_tive_device_id: "filter_tive_device_id",
14         filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
15         filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16     });
17 }
18 main();

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "_id": "5f8d0d55b54764421b7156c3",
6       "org_id": "org_9a8b7c6d5e4f3g2h1i0j",
7       "tive_account_id": 123456,
8       "tive_account_name": "Global Logistics Inc.",
9       "tive_device_id": "device_7890abcd1234efgh",
10       "tive_device_name": "Tive Tracker Alpha",
11       "chrt_created_at_timestamp": "2024-04-10T14:22:00Z",
12       "chrt_updated_at_timestamp": "2024-04-15T08:45:00Z",
13       "tive_current_shipment_id": "shipment_4567xyz890",
14       "tive_current_public_shipment_id": "public_shipment_4567xyz890"
15     }
16   ],
17   "total_count": 1
18 }

Lists Tive devices with filtering, sorting, and pagination. Scoped to the caller’s organization. | authz: min_org_role=operator | () -> (TiveDeviceListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_tive_account_idinteger or nullOptional

Filter by Tive account ID

filter_tive_device_idstring or nullOptional

Filter by Tive device ID (exact match)

filter_chrt_created_at_timestamp_gtedatetime or nullOptional

Filter by chrt_created_at_timestamp >= value

filter_chrt_created_at_timestamp_ltedatetime or nullOptional

Filter by chrt_created_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Devices List V1request Unprocessable Entity Error

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.trackingIntegrations.tive.devices.listV1({
8	sort_by: "chrt_created_at_timestamp",
9	sort_order: "asc",
10	page: 1,
11	page_size: 1,
12	filter_tive_account_id: 1,
13	filter_tive_device_id: "filter_tive_device_id",
14	filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
15	filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16	});
17	}
18	main();

1	{
2	"items": [
3	{
4	"schema_version": 1,
5	"_id": "5f8d0d55b54764421b7156c3",
6	"org_id": "org_9a8b7c6d5e4f3g2h1i0j",
7	"tive_account_id": 123456,
8	"tive_account_name": "Global Logistics Inc.",
9	"tive_device_id": "device_7890abcd1234efgh",
10	"tive_device_name": "Tive Tracker Alpha",
11	"chrt_created_at_timestamp": "2024-04-10T14:22:00Z",
12	"chrt_updated_at_timestamp": "2024-04-15T08:45:00Z",
13	"tive_current_shipment_id": "shipment_4567xyz890",
14	"tive_current_public_shipment_id": "public_shipment_4567xyz890"
15	}
16	],
17	"total_count": 1
18	}