CHchrt
/tracking

List

Changed on

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

get/tracking/devices/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/tracking/devices/list/v1
  • Auth
    HTTP bearer

Query parameters

sort_by'registered_at_timestamp' | 'last_seen_at_timestamp' | 'first_seen_at_timestamp'

Field to sort by

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc)

pageinteger
page_sizeinteger
searchstring nullable

Full-text search query

org_scope'owned' | 'shared' | 'owned_and_shared'

Filter by org ownership: owned, shared, or owned_and_shared

filter_device_idsstring[] nullable

Filter by selected device ids

filter_device_mac_addressstring nullable

Filter by device MAC address (exact match)

filter_off_chrt_reference_idstring nullable

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved).

Filter by off-CHRT reference ID (exact match)

filter_type'D15N-tag' | 'MTB06-label' | 'T3-D-tag'

Filter by device type

filter_active_cargo_idstring nullable

Filter by active cargo ID

filter_active_session_idstring nullable

Filter by active session ID

filter_has_active_sessionboolean nullable

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

filter_has_active_cargoboolean nullable

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

filter_registered_at_timestamp_gtestring date-time nullable

Filter by registered_at_timestamp >= value

filter_registered_at_timestamp_ltestring date-time nullable

Filter by registered_at_timestamp <= value

filter_last_seen_at_timestamp_gtestring date-time nullable

Filter by last_seen_at_timestamp >= value

filter_last_seen_at_timestamp_ltestring date-time nullable

Filter by last_seen_at_timestamp <= value

filter_first_seen_at_timestamp_gtestring date-time nullable

Filter by first_seen_at_timestamp >= value

filter_first_seen_at_timestamp_ltestring date-time nullable

Filter by first_seen_at_timestamp <= value

filter_archivedboolean nullable

Filter by archived status

Response

Successful Response

total_countinteger required

Changes

  • b5a0a0e20ff8Revision changes
    • warning

      deleted the query request parameter filter_device_id

    • info

      added the new optional query request parameter filter_device_ids

  • 90f02389cb0dRevision changes
    • info

      added the new optional query request parameter filter_device_id

    • info

      added the new optional query request parameter filter_device_mac_address