Get Contact icon

Get Contact

Send parameter to get contact via PEAK API

Get Contact

AI-generated

Summary

Retrieve contact details from the PEAK API by providing either a Contact ID or Contact Code, specifying the server environment, and optionally overriding the client token.

Inputs

  • Server Environment (required) — Select the environment (UAT or Production) where the contact lookup should be performed.
  • Contact ID — Specify the contact's unique identifier to retrieve its details.
  • Contact Code — Specify the contact's code as an alternative identifier to retrieve contact details.
  • Client Token (override) — Optionally provide a client token to override the credential token, useful if the token refreshes frequently.

Output shape

a single item containing JSON with keys success, statusCode, data (the contact info returned by the PEAK API), and headers (the request headers used). On failure, outputs an error message within the JSON and associates it with the respective input item index.

If both Contact ID and Contact Code are provided, both are included as query parameters. The Client Token override, if specified, takes precedence over the credential token. Requests target a different URL depending on the server environment. If no client token is available, the operation throws an error. Errors can be configured to either halt execution or continue with error output per item.

Discussion