list_document_parties · List a document's parties

Contract

shape: collection
authority: read
evidence: none
subscription: false
permission: any one of: org.member (carried by the caller's role template in the org `org_id`, which owns the document `document_kind`/`document_id`); counterparty (org.member carried by the caller's role template in an org that holds a seat on the document; it reads its own seat); a deactivated caller is refused first
idempotency: safe
emits: none
MCP tool: list_document_parties
REST: POST https://api.containertradehq.com/v1/cap/list_document_parties

Idempotency: a read: calling again changes nothing

Inputs

name	type	required	validation
org_id	org_id	required	tradehq-org-id; 1 to 20 characters The org that owns the document.
document_kind	one_of	required	one of asset_intake, order The table the document is in: asset_intake (a purchase order) or order.
document_id	text	required	1 to 64 characters The document's id in that table.

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": {
          "party_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 party, in the shared directory.",
            "x-data-class": "operational"
          },
          "party_name": {
            "type": "string",
            "description": "The party's name in the directory.",
            "x-data-class": "operational"
          },
          "seat": {
            "type": "string",
            "enum": [
              "buyer",
              "lessee",
              "lessor",
              "seller"
            ],
            "description": "The seat it holds on this document.",
            "x-data-class": "operational"
          },
          "party_org_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 20,
            "pattern": "^[A-Za-z0-9_-]{1,20}$",
            "format": "tradehq-org-id",
            "description": "The Trade HQ org that has claimed the party; null when none has.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "party_id",
          "party_name",
          "seat",
          "party_org_id"
        ],
        "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 party listing
Outbound: the counterparty reads its own seat here; nothing is sent to it

Events

None emitted.

invite_guest, set_document_parties