PEAK icon

PEAK

Interact with the PEAK Accounting API

Actions11

Contact → Get

AI-generated

Summary

Retrieve a specific contact from the PEAK Accounting API by providing either the Contact ID or Contact Code.

Inputs

  • Server Environment (required) — Select the PEAK server environment to use, either 'UAT' or 'Production'.
  • Contact ID — The unique identifier of the contact to retrieve.
  • Contact Code — The unique code of the contact to retrieve.
  • Client Token — Optional client token for authentication; if not supplied, a token must be obtained via the Create Client Token operation.

Output shape

a single record representing the contact matching the provided Contact ID or Contact Code.

Either 'Contact ID' or 'Contact Code' must be provided; if both are supplied, both are used as query parameters. The operation requires a client token unless explicitly skipped by passing 'none'. Errors occur if neither identifier is given or if authentication fails.

Examples

Example 1: Retrieve a contact by ID from the Production environment

Set Server Environment to 'Production', enter the Contact ID, optionally provide a Client Token if not using stored credentials.

Links

Discussion