List | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.tracking.devices.listV1({
        sort_by: "registered_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        search: "search",
        org_scope: "owned",
        filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
        filter_type: "D15N-tag",
        filter_active_cargo_id: "filter_active_cargo_id",
        filter_active_session_id: "filter_active_session_id",
        filter_has_active_session: true,
        filter_has_active_cargo: true,
        filter_registered_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_registered_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_first_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_first_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_archived: true,
    });
}
main();

{
  "items": [
    {
      "_id": "device_1234567890abcdef",
      "schema_version": 1,
      "org_id": "org_9876543210abcd",
      "device_mac_address": "00:1A:7D:DA:71:13",
      "device_token": "a1b2c3d4e5f67890",
      "type": "D15N-tag",
      "comments": "Installed on container #42 for temperature monitoring",
      "off_chrt_reference_id": "REF_20240115_001",
      "registered_at_timestamp": "2024-01-15T09:30:00Z",
      "first_seen_at_timestamp": "2024-01-15T09:30:00Z",
      "last_seen_at_location": {
        "type": "Feature",
        "geometry": {
          "type": "GeometryCollection",
          "geometries": [
            {
              "type": "LineString",
              "coordinates": [
                [
                  -122.4194,
                  37.7749
                ],
                [
                  -122.418,
                  37.7755
                ],
                [
                  -122.417,
                  37.776
                ]
              ]
            }
          ]
        }
      },
      "last_seen_at_timestamp": "2024-04-20T14:45:00Z",
      "last_seen_battery_level": "85%",
      "archived": true,
      "paused": true,
      "pause_windows": [
        {
          "start_timestamp": "2024-03-01T00:00:00Z",
          "end_timestamp": "2024-03-10T23:59:59Z"
        }
      ],
      "shared_with_org_ids": [
        "org_123abc456def"
      ],
      "off_chrt_shipper_org_id": "shipper_789xyz123abc",
      "active_session_id": "session_20240420_001",
      "active_cargo_id": "cargo_20240420_001"
    }
  ],
  "total_count": 1
}

Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query

org_scopeenumOptional

Filter by org ownership: owned, shared, or owned_and_shared

Allowed values:

filter_off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Filter by off-CHRT reference ID (exact match)

filter_typeenumOptional

Filter by device type

Allowed values:

filter_active_cargo_idstringOptional

Filter by active cargo ID

filter_active_session_idstringOptional

Filter by active session ID

filter_has_active_sessionbooleanOptional

Filter by whether device has an active session (true = session_id is not null, false = session_id is null)

filter_has_active_cargobooleanOptional

Filter by whether device has an active cargo (true = cargo_id is not null, false = cargo_id is null)

filter_registered_at_timestamp_gtedatetimeOptional

Filter by registered_at_timestamp >= value

filter_registered_at_timestamp_ltedatetimeOptional

Filter by registered_at_timestamp <= value

filter_last_seen_at_timestamp_gtedatetimeOptional

Filter by last_seen_at_timestamp >= value

filter_last_seen_at_timestamp_ltedatetimeOptional

Filter by last_seen_at_timestamp <= value

filter_first_seen_at_timestamp_gtedatetimeOptional

Filter by first_seen_at_timestamp >= value

filter_first_seen_at_timestamp_ltedatetimeOptional

Filter by first_seen_at_timestamp <= value

filter_archivedbooleanOptional

Filter by archived status

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Devices List V1request Unprocessable Entity Error