PEAK Get Contact icon

PEAK Get Contact

Send parameter to get contact via PEAK API

PEAK Get Contact

AI-generated

Summary

Retrieves a PEAK contact by ID or code using the configured credentials and server environment, authenticating requests with a HMAC-SHA1 signature.

Inputs

  • serverEnvironment (required) — Select the target server environment: 'UAT' or 'Production' (defaults to Production).
  • contactId — The specific Contact ID to retrieve. If omitted, the operation uses Contact Code instead.
  • contactCode — The Contact Code to retrieve. If omitted, the operation uses Contact ID instead.
  • clientTokenOverride — Optional override for the Client Token. Required if the credential token is missing or expired.

Output shape

A single output item containing a JSON object with 'success', 'statusCode', 'data' (the API response), and 'headers' (request headers).

If continueOnFail is enabled, items with errors are returned with an 'error' field instead of data.

Examples

Example 1: Retrieve a production contact by ID

Server Environment: Production; Contact ID: '12345'

Example 2: Retrieve a UAT contact by code

Server Environment: UAT; Contact Code: 'ABC123'

Links

Discussion