Skip to main content
GET
/
contact
/
{customerId}
/
id
/
{id}
Retrieve a contact by ID
curl --request GET \
  --url https://api.example.com/contact/{customerId}/id/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "phoneNumber": "+1234567890",
  "countryCode": "US",
  "nationalFormat": "(123) 456-7890",
  "availableChannels": "SMS,WHATSAPP",
  "defaultChannel": "WHATSAPP",
  "verified": true,
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
customerId
string<uuid>
required

Unique identifier of the customer account

​
id
string<uuid>
required

Unique identifier of the contact

Response

Contact details successfully retrieved

Represents a contact in the Sent messaging platform with their communication preferences and channel availability

​
id
string<uuid>

Unique identifier for the contact

​
phoneNumber
string

Contact's phone number in E.164 format

​
countryCode
string

Two-letter ISO country code

​
nationalFormat
string

Phone number formatted according to national standards

​
availableChannels
string

Comma-separated list of available messaging channels (SMS, WHATSAPP)

​
defaultChannel
string

Preferred messaging channel for this contact

​
verified
boolean

Indicates if the contact's phone number has been verified

​
createdAt
string<date-time>

Timestamp when the contact was created

​
updatedAt
string<date-time>

Timestamp when the contact was last updated