list_devices · List my devices · Container Trade HQ API

Contract

shape: collection
authority: read
evidence: none
subscription: false
permission: any one of: self.read (the signed-in caller, about themself only; it names no other user); a deactivated caller is refused first
idempotency: safe
emits: none
MCP tool: list_devices
REST: POST https://api.containertradehq.com/v1/cap/list_devices

Idempotency: a read: calling again changes nothing

Inputs

No inputs.

Paginated: next next_after · ceiling not_declared

Response

items · object[]
next_after · stringnull · Pass as `after` for the next page; null on the last one.

Full JSON Schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "binding_id": {
            "type": "string",
            "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
            "format": "uuid",
            "description": "The binding: what revoke_device takes.",
            "x-data-class": "operational"
          },
          "installation_id": {
            "type": "string",
            "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
            "format": "uuid",
            "description": "The installation.",
            "x-data-class": "operational"
          },
          "platform": {
            "type": "string",
            "enum": [
              "ios",
              "android"
            ],
            "description": "Its platform.",
            "x-data-class": "operational"
          },
          "app_version": {
            "type": "string",
            "description": "The app version it registered with.",
            "x-data-class": "operational"
          },
          "bound_org_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 20,
            "pattern": "^[A-Za-z0-9_-]{1,20}$",
            "format": "tradehq-org-id",
            "description": "The org it was bound in.",
            "x-data-class": "operational"
          },
          "managed": {
            "type": "boolean",
            "description": "A managed (shared) device, which reads only.",
            "x-data-class": "operational"
          },
          "push": {
            "type": "boolean",
            "description": "Whether it has a live push destination.",
            "x-data-class": "operational"
          },
          "bound_at": {
            "type": "string",
            "format": "date-time",
            "description": "When it was bound.",
            "x-data-class": "operational"
          },
          "revoked_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When it was revoked; null while it stands.",
            "x-data-class": "operational"
          },
          "this_device": {
            "type": "boolean",
            "description": "Whether it is the device making this call.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "binding_id",
          "installation_id",
          "platform",
          "app_version",
          "bound_org_id",
          "managed",
          "push",
          "bound_at",
          "revoked_at",
          "this_device"
        ],
        "additionalProperties": false
      }
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}

Refusals

not yet declared

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF

MobileF

APIF

MCPF

VoiceD4

PushN

OneBoxN

OutboundN

Voice: degraded: visualization
Push: emits nothing
OneBox: no document originates a device listing
Outbound: crosses to no counterparty

Events

None emitted.

None.