MAmailchimp
audiences

Get a contact record

Retrieve a specific omni-channel contact in an audience.

get/3.0/audiences/{audience_id}/contacts/{contact_id}

Request

Path parameters

audience_idstring required

The unique ID for the audience.

contact_idstring required

A unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number).

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Response

audience_idstring

The unique ID for the audience.

created_atstring date-time

The date that the contact was created.

idstring

The unique ID for the contact.

language'' | 'en' | 'ar' | 'af' | 'be' | 'bg' | 'ca' | 'zh' | 'zh_CN' | 'hr' | 'cs' | 'da' | 'nl' | 'et' | 'fa' | 'fi' | 'fr' | 'fr_CA' | 'de' | 'el' | 'he' | 'hi' | 'hu' | 'is' | 'id' | 'ga' | 'it' | 'ja' | 'km' | 'ko' | 'lv' | 'lt' | 'mt' | 'ms' | 'mk' | 'no' | 'pl' | 'pt' | 'pt_PT' | 'ro' | 'ru' | 'sr' | 'sk' | 'sl' | 'es' | 'es_ES' | 'sw' | 'sv' | 'ta' | 'th' | 'tr' | 'uk' | 'vi'

The contact's detected language. Empty string when no language has been detected or set.

last_updated_atstring date-time

The date that the contact was last updated.

merge_fieldsobject nullable

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

status'active' | 'archived'

The status of a contact.

tagsstring[]

The tags assigned to this contact.

Example response

{
  "audience_id": "773280e405",
  "email_channel": {
    "email": "example@freddiemail.com",
    "hashed_email": "9115d71ba28088047d342e3bcedacd0f",
    "marketing_consent": {
      "captured_at": "2024-01-15T10:30:00Z"
    }
  },
  "id": "7CCF816ADF6CE1B11AE09BB024A02B9B",
  "language": "en",
  "sms_channel": {
    "marketing_consent": {
      "captured_at": "2024-01-15T10:30:00Z"
    },
    "sms_phone": "+14045550102",
    "hashed_sms_phone": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609"
  },
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.