Skip to main content
GET
Get an external party

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Agent-ID
string | null

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

Maximum string length: 36
Pattern: ^agt_[0-9a-f]{32}$
X-Instance-ID
string | null

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

Maximum string length: 1024

Path Parameters

externalPartyId
string
required

External party ID (epty_*).

Pattern: ^epty_[0-9a-f]{32}$

Query Parameters

customerPartyId
string

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

Pattern: ^pty_[0-9a-f]{32}$

Response

Successful Response

data
ExternalPartyResource · object
required