Get Contact

To get a contact, make a POST request to the following endpoint:

https://api.peach-in.com/v4/getContact

Request

Include your API key in the Authorization header of the request, as described in the Authorization section.

Request Body

You must include one of the following fields in the request body:

{
  "contactId": "49425860-202c-11f0-91c6-472f50892278"
}

or

{
  "email": "[e-mail]"
}

or

{
  "phoneNumber": "0587701234"
}

or

{
  "tz": "123456789"
}

Response

A successful response to the get contact endpoint will return the contact object in the JSON format. The response will include various details about the contact, such as its ID, name, and any associated details.

200: OK

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "[e-mail]",
      "telephone": "[phone]",
      "address": "123 Main St",
      "city": "Jerusalem",
      "street": "Main St",
      "streetNumber": "123",
      "aptNumber": "4",
      "zipCode": "12345",
      "contactId": "49425860-202c-11f0-91c6-472f50892278",
      "groups": ["VIP", "Newsletter"],
      "customProperties": {
        "tzyvn": 100
      }
    }
  ]
}