List | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.trackingIntegrations.tive.devices.listV1({
        sort_by: "chrt_created_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_tive_account_id: 1,
        filter_tive_device_id: "filter_tive_device_id",
        filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "items": [
    {
      "schema_version": 1,
      "_id": "5f8d0d55b54764421b7156c3",
      "org_id": "org_9f8d7a6b5c4d3e2f1a0b",
      "tive_account_id": 123456,
      "tive_account_name": "Global Logistics Inc.",
      "tive_device_id": "device_7890abcd1234ef56",
      "tive_device_name": "Tive Tracker Alpha",
      "chrt_created_at_timestamp": "2024-01-15T09:30:00Z",
      "chrt_updated_at_timestamp": "2024-04-10T14:45:00Z",
      "tive_current_shipment_id": "shipment_4567efgh8901ijkl",
      "tive_current_public_shipment_id": "public_shipment_4567efgh8901ijkl"
    }
  ],
  "total_count": 1
}

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