Search | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.tracking.devices.searchV1({
        query: "query",
        page: 1,
        page_size: 1,
        org_scope: "owned",
    });
}
main();

{
  "devices": [
    {
      "_id": "_id",
      "schema_version": 1,
      "org_id": "org_id",
      "device_mac_address": "device_mac_address",
      "device_token": "device_token",
      "type": "D15N-tag",
      "comments": "comments",
      "off_chrt_reference_id": "off_chrt_reference_id",
      "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": [
                []
              ]
            }
          ]
        }
      },
      "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
      "last_seen_battery_level": "last_seen_battery_level",
      "archived": true,
      "shared_with_org_ids": [
        "shared_with_org_ids"
      ],
      "off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
      "active_session_id": "active_session_id",
      "active_cargo_id": "active_cargo_id"
    }
  ],
  "total_count": 1
}

Search across device device_mac_address, comments, and off_chrt_reference_id. Handles both partial (typing) and full query submission. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceSearchRes)

Authentication

AuthorizationBearer

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

Query parameters

querystringRequired

Search query

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

org_scopeenumOptional

Filter by org ownership: owned, shared, or owned_and_shared

Allowed values:

Response

Successful Response

deviceslist of objects

total_countinteger

Authentication

Query parameters

Response

Errors