Get Contact

Required scope: contact:read

A contact is a person identified by an email address and/or phone number. A contact can be linked to one or more customers. Email and phone are returned as flat, already-normalized fields: phoneE164 is the E.164 form of the number.

Generated Reference

POST /public-api/publicapi.v1.Contact/GetContact

Returns a contact by ID.

Request GetContactRequest

Response GetContactResponse

GetContactRequest

Field	Type	Description
id	string	Contact to return.

GetContactResponse

Field	Type	Description
contact	Contact	The requested contact.

Related Types

Contact

Field	Type	Description
id	string	Stable contact identifier.
name	string	Display name, if set.
email	string	Email address, if set.
phone_e164	string	Phone number in E.164 format, if set.
customer_number	string	Human-facing customer number when the contact is linked to a customer.
locale	string	BCP 47 locale tag, for example "en" or "nl-NL", if set.
created_at	int64	Creation time as a Unix timestamp in seconds.
updated_at	int64	Last-update time as a Unix timestamp in seconds.

Request

{
  "id": "<contact-id>"
}

Response

{
  "contact": {
    "id": "<contact-id>",
    "name": "Alex Jansen",
    "email": "[email protected]",
    "phoneE164": "+31612345678",
    "customerNumber": "C-000123",
    "locale": "nl-NL",
    "createdAt": 1726300000,
    "updatedAt": 1726400000
  }
}