External Parties

Get an external party

Get an external party by ID

get/external-parties/{externalPartyId}

Path parameters

externalPartyIdstring required

External party ID (epty_*).

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.

X-Instance-IDstring nullable

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

Successful Response

Changed in 4 of the 28 revisions of this API.4

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 22, 2026efd3da4713981See the full diff
- ○
  added the new optional query request parameter customerPartyId
  new-optional-request-parameter
Aug 19, 2026c2c65e0527111See the full diff
- ○
  endpoint added
  endpoint-added