List a contact's addresses

List a contact's addresses

GET/api/v1/contacts/{id}/addresses

GET /contacts/{id}/addresses
curl -X GET 'https://www.unitpost.com/api/v1/contacts/con_123/addresses' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "contact_address",
      "channel": "string",
      "address": "string",
      "primary": false,
      "status": "queued",
      "country": "string",
      "verified_at": "2026-01-01T00:00:00.000Z",
      "consented_at": "2026-01-01T00:00:00.000Z",
      "consent_source": "string",
      "consent_purpose": "string",
      "carrier_opt_out_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Every address the contact can be reached at: its email addresses and SMS numbers, each with its status and, for a number, its SMS consent state. The contact's phone is its primary number; this lists all of them, including numbers the person texted in from. The full consent history is Get a contact's SMS consent. The {id} accepts a contact id or email. Not paginated. Requires the contacts:read capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields12 fields
FieldTypeDescription
objectrequiredstring—
channelrequiredstring`email` for an email address, `sms` for a phone number.
addressrequiredstringThe email address, or the phone number in E.164.
primaryrequiredbooleanThe address sends use for this channel.
statusrequiredstring`active`, or why it can't be used (e.g. `opted_out`, `bounced`).
countryrequiredstring | nullISO country of a phone number.
verified_atrequiredstring | null—
consented_atrequiredstring | nullWhen SMS consent was recorded (see `/contacts/{id}/sms-consent`).
consent_sourcerequiredstring | null—
consent_purposerequiredstring | null—
carrier_opt_out_atrequiredstring | nullWhen the carrier last refused a text to this number because it opted out at the carrier. Not a consent record.
created_atrequiredstring—
200401403404

Search docs and guides

Search the docs and product guides.