latestOpenAPI 3.1.12026-08-239938.6 MB

b1ad79e918ac

External Parties

Get an external party

Get an external party by ID

get/external-parties/{externalPartyId}

Path parameters

externalPartyIdstring required

External party ID (epty_*).

Query parameters

customerPartyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

X-Agent-IDstring nullable

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response