search_party_directory · Search the party directory

Contract

shape: collection
authority: read
evidence: none
subscription: false
permission: any one of: any.authenticated (any signed-in caller with a user row; a read of a registry every tenant sees the same); a deactivated caller is refused first
idempotency: safe
emits: none
MCP tool: search_party_directory
REST: POST https://api.containertradehq.com/v1/cap/search_party_directory

Idempotency: a read: calling again changes nothing

Inputs

name	type	required	validation
query	text	optional	1 to 100 characters A case-insensitive substring of the party's name.
limit	integer	optional	1 to 200; default 50 The page size.
after	uuid	optional	UUID The previous page's next_after.
org_id	org_id	optional	tradehq-org-id; 1 to 20 characters An org the caller is a member of, for yours. Absent, yours is null.

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's id: what claim_party and set_document_parties name.",
            "x-data-class": "operational"
          },
          "name": {
            "type": "string",
            "description": "The party's name.",
            "x-data-class": "operational"
          },
          "claimed": {
            "type": "boolean",
            "description": "Whether an org has claimed the party (claim_party). Which org is not said.",
            "x-data-class": "operational"
          },
          "yours": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether the org named by org_id claims the party; null when no org_id is given.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "party_id",
          "name",
          "claimed",
          "yours"
        ],
        "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 directory search
Outbound: crosses to no counterparty

Events

None emitted.

create_data_share, list_files, list_guests, preview_data_share, search_records