NAnatural
External Parties

Get external party

Changed on

Get an external party

get/external-parties/{externalPartyId}

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/external-parties/{externalPartyId}
  • Auth
    HTTP bearer

Path parameters

externalPartyIdstring required

External party ID (epty_*).

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

X-Instance-IDstring nullable

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

Response

Successful Response

Changes

  • 226131258c12Revision changes
    • info

      added the required property // to the response with the status

  • c7c12da5915fRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status