GET a Contact

This endpoint GETs a specific contact resource (contact_id). Use the include query parameter to add any of the available contact sub-resources to the response payload.

contact_idstring required

Unique ID of contact to GET

Use include to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: custom_fields, list_memberships, phone_numbers, street_addresses, notes, and taggings.

Response

Request successful

contact_idstring uuid

Unique ID for each contact resource

first_namestring

The first name of the contact.

last_namestring

The last name of the contact.

job_titlestring

The job title of the contact.

company_namestring

The name of the company where the contact works.

birthday_monthinteger

The month value for the contact's birthday. Valid values are from 1 through 12. You must use this property with <code>birthday_month</code>.

birthday_dayinteger

The day value for the contact's birthday. Valid values are from 1 through 12. You must use this property with <code>birthday_day</code>.

anniversarystring

The anniversary date for the contact. For example, this value could be the date when the contact first became a customer of an organization in Constant Contact. Valid date formats are MM/DD/YYYY, M/D/YYYY, YYYY/MM/DD, YYYY/M/D, YYYY-MM-DD, YYYY-M-D,M-D-YYYY, or M-DD-YYYY.

update_sourcestring

Identifies who last updated the contact; valid values are <code>Contact</code> or <code>Account</code>.

create_sourcestring

Describes who added the contact; valid values are <code>Contact</code> or <code>Account</code>. Your integration must accurately identify <code>create_source</code> for compliance reasons; value is set when contact is created.

created_atstring date-time

System generated date and time that the resource was created, in ISO-8601 format.

updated_atstring date-time

System generated date and time that the contact was last updated, in ISO-8601 format.

deleted_atstring date

For deleted contacts (<code>email_address</code> contains <code>opt_out_source</code> and <code>opt_out_date</code>), shows the date of deletion.

list_membershipsstring[]

Array of up to 50 <code>list_ids</code> to which the contact is subscribed.

taggingsstring[]

Array of tags (<code>tag_id</code>) assigned to the contact, up to a maximum of 50.

Example response

{
  "contact_id": "1618ae62-4752-11e9-9c8a-fa163e6b01c1",
  "email_address": {
    "address": "dlang@example.com",
    "permission_to_send": "implicit",
    "created_at": "2016-03-03T10:53:04-05:00",
    "updated_at": "2016-03-03T10:56:29-05:00",
    "opt_in_source": "Contact",
    "opt_in_date": "2016-01-23T13:48:44.108Z",
    "opt_out_source": "Contact",
    "opt_out_date": "2016-01-23T13:48:44.108Z",
    "opt_out_reason": "I am no longer interested in this service.",
    "confirm_status": "confirmed"
  },
  "first_name": "Debora",
  "last_name": "Lang",
  "job_title": "Musician",
  "company_name": "Acme Corp.",
  "birthday_month": 11,
  "birthday_day": 24,
  "anniversary": "2006-11-15",
  "update_source": "Contact",
  "create_source": "Account",
  "created_at": "2016-01-23T13:48:44.108Z",
  "updated_at": "2016-01-23T13:48:44.108Z",
  "deleted_at": "2016-07-08",
  "custom_fields": [
    {
      "custom_field_id": "1618ae62-4752-11e9-9c8a-fa163e6b01c1",
      "value": "Tesla S 2017",
      "choice_ids": [
        "000001"
      ]
    }
  ],
  "phone_numbers": [
    {
      "phone_number_id": "6eec28a6-1cf5-11ea-859f-fa163e56c9b0",
      "phone_number": "+1-555-555-5555",
      "kind": "home",
      "created_at": "2016-03-03T10:53:04-05:00",
      "updated_at": "2016-03-03T10:56:29-05:00",
      "update_source": "Account",
      "create_source": "Account"
    }
  ],
  "street_addresses": [
    {
      "street_address_id": "977a9a2e-3e00-11ea-804b-fa163e56c9b0",
      "kind": "home",
      "street": "123 Kashmir Valley Road",
      "city": "Chicago",
      "state": "Illinois",
      "postal_code": "60609",
      "country": "United States",
      "created_at": "2016-03-03T10:53:04-05:00",
      "updated_at": "2016-03-03T10:56:29-05:00"
    }
  ],
  "list_memberships": [
    "07936f78-662a-11eb-af0a-fa163e56c9b0"
  ],
  "taggings": [
    "e7ddac60-51da-11eb-b3a4-fa163e6b01c1"
  ],
  "notes": [
    {
      "note_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2021-05-12T13:48:44.108Z",
      "content": "This contact resubscribed on 2021-05-12."
    }
  ],
  "sms_channel": {
    "sms_channel_id": "3fa85f64-5712-6245-b3fc-2c963f66bfc6",
    "sms_address": "7815551212",
    "dial_code": "1",
    "country_code": "US",
    "update_source": "Contact",
    "create_source": "Account",
    "sms_channel_consents": [
      {
        "sms_consent_permission": "explicit",
        "consent_type": "promotional_sms",
        "opt_in_date": "2016-01-23T13:48:44.108Z",
        "opt_out_date": "2016-01-23T13:48:44.108Z",
        "advertised_frequency": "1",
        "advertised_interval": "monthly",
        "created_at": "2016-01-23T13:48:44.108Z",
        "updated_at": "2016-01-23T13:48:44.108Z"
      }
    ]
  }
}

v1

GET a Contact

Path parameters

Query parameters

Response

Example response