Peach icon

Peach

Interact with the Peach WhatsApp Platform API

Actions17

Contact → Get

AI-generated

Summary

Retrieves a single contact from the Peach WhatsApp platform by phone number, using a GET request to /api/v1/contacts/{phoneNumber}.

Inputs

  • Phone Number (required) — Contact's phone number including country code. It is placed directly in the request URL path.
  • Request Options — Optional node settings for the HTTP request: batching (items per batch, default 50, and interval in ms, default 1000), ignore SSL issues, proxy URL, and timeout in ms (default 10000).

Output shape

The contact record returned by the Peach API as JSON, one output item per input item.

The exact fields come from the Peach API and are not defined in the node. The node is declarative, so no custom parsing happens. A contact that doesn't exist will likely cause an API error such as 404, but this is not handled in the node source. Requires Peach API credentials.

Examples

Example 1: Look up a contact by the phone number from an incoming webhook before sending a message.

Resource: Contact, Operation: Get, Phone Number: {{ $json.phone }} (e.g. +14155550123)

Example 2: Look up many contacts without overloading the API.

Resource: Contact, Operation: Get, Phone Number: expression from each input item; Request Options > Batching: 20 items per batch, 2000 ms interval

Links

Discussion