Get a contact record

GET

https://api.mailchimp.com/3.0/audiences/:audience_id/contacts/:contact_id

GET

/3.0/audiences/:audience_id/contacts/:contact_id

curl https://api.mailchimp.com/3.0/audiences/audience_id/contacts/contact_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "audience_id": "773280e405",
  "created_at": "2024-01-15T09:30:00Z",
  "email_channel": {
    "effective_subscription_status": {
      "value": "subscribed"
    },
    "email": "example@freddiemail.com",
    "hashed_email": "9115d71ba28088047d342e3bcedacd0f",
    "marketing_consent": {
      "source": {
        "name": "string"
      },
      "status": "consented",
      "captured_at": "2024-01-15T10:30:00Z"
    },
    "source": {
      "name": "string"
    }
  },
  "id": "7CCF816ADF6CE1B11AE09BB024A02B9B",
  "language": "en",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "merge_fields": {},
  "sms_channel": {
    "effective_subscription_status": {
      "value": "subscribed"
    },
    "marketing_consent": {
      "source": {
        "name": "string"
      },
      "status": "consented",
      "captured_at": "2024-01-15T10:30:00Z"
    },
    "sms_phone": "+14045550102",
    "source": {
      "name": "string"
    },
    "hashed_sms_phone": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609"
  },
  "source": {
    "name": "string"
  },
  "status": "active",
  "tags": [
    "string"
  ]
}

Retrieve a specific omni-channel contact in an audience.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

audience_idstringRequired

The unique ID for the audience.

contact_idstringRequired

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

fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

Response

This endpoint returns an object.

audience_idstringOptionalRead-only

The unique ID for the audience.

created_atdatetimeOptionalRead-only

The date that the contact was created.

email_channelobjectOptional

idstringOptionalRead-only

The unique ID for the contact.

languageenumOptional

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

last_updated_atdatetimeOptionalRead-only

The date that the contact was last updated.

merge_fieldsmap from strings to objects or strings or doubles or nullOptional

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

sms_channelobjectOptional

sourceobjectOptional

The source from which the parent's entity was created.

statusenumOptionalRead-only

The status of a contact.

Allowed values:

tagslist of stringsOptional

The tags assigned to this contact.