Retrieve a Contact

GET https://api.chartmogul.com/v1/contacts/{CONTACT_UUID}

Retrieves a contact object from your ChartMogul account.

curl -X GET "https://api.chartmogul.com/v1/contacts/con_653af916-dea0-11ed-845b-3be1ac0039ac?with_overrides=true&attributes_with_history=title" \
     -u YOUR_API_KEY: 
ChartMogul::Contact.retrieve("con_653af916-dea0-11ed-845b-3be1ac0039ac")
ChartMogul.Contact.retrieve(config, "con_653af916-dea0-11ed-845b-3be1ac0039ac");
ChartMogul\Contact::retrieve("con_653af916-dea0-11ed-845b-3be1ac0039ac");
api.RetrieveContact("con_653af916-dea0-11ed-845b-3be1ac0039ac")
chartmogul.Contact.retrieve(config, uuid="con_653af916-dea0-11ed-845b-3be1ac0039ac")
{
  "uuid": "con_653af916-dea0-11ed-845b-3be1ac0039ac",
  "customer_uuid": "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  "customer_external_id": "customer_001",
  "data_source_uuid": "ds_35542640-d9f1-11ed-9c30-7727168c74a5",
  "external_id": "cont_001",
  "position": 9,
  "first_name": "Adam",
  "last_name": "Smith",
  "title": "CEO",
  "email": "[email protected]",
  "phone": "+1234567890",
  "linked_in": "https://linkedin.com/example",
  "twitter": "https://twitter.com/example",
  "notes": "Heading\nBody\nFooter",
  "last_seen": "2026-01-01T16:58:58.000Z",
  "custom": {
    "Facebook": "https://www.facebook.com/adam.smith",
    "date_of_birth": "1985-01-22"
  },
  "overrides": { "title": true },
  "historical_values": {
    "title": [
      { "value": "CEO", "update_performed_at": "2026-05-11T08:03:47Z", "update_performed_by": "Adam Kowalski", "initial": false },
      { "value": null, "update_performed_at": null, "update_performed_by": null, "initial": true }
    ]
  }
}
#<ChartMogul::Contact:0x0000000128fada38
  @custom={
    :Facebook=>"https://www.facebook.com/adam.smith",
    :date_of_birth=>"1985-01-22"
  },
  @customer_external_id="customer_001",
  @customer_uuid="cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  @data_source_uuid="ds_35542640-d9f1-11ed-9c30-7727168c74a5",
  @external_id="cont_001",
  @email="[email protected]",
  @first_name="Adam",
  @last_name="Smith",
  @linked_in="https://linkedin.com/example",
  @notes="Heading\nBody\nFooter",
  @phone="+1234567890",
  @position=9,
  @title="CEO",
  @twitter="https://twitter.com/example",
  @uuid="con_653af916-dea0-11ed-845b-3be1ac0039ac"
>
{
  uuid: "con_653af916-dea0-11ed-845b-3be1ac0039ac",
  customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  customer_external_id: "customer_001",
  data_source_uuid: "ds_35542640-d9f1-11ed-9c30-7727168c74a5",
  external_id: "cont_001",
  position: 9,
  first_name: "Adam",
  last_name: "Smith",
  title: "CEO",
  email: "[email protected]",
  phone: "+1234567890",
  linked_in: "https://linkedin.com/example",
  twitter: "https://twitter.com/example",
  notes: "Heading\nBody\nFooter",
  custom: {
    Facebook: "https://www.facebook.com/adam.smith",
    date_of_birth: "1985-01-22"
  }
}
class ChartMogul\Contact (15) {
  protected $uuid => string(40) "con_653af916-dea0-11ed-845b-3be1ac0039ac"
  protected $customer_uuid => string(40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0"
  protected $data_source_uuid => string(39) "ds_35542640-d9f1-11ed-9c30-7727168c74a5"
  protected $external_id => string(8) "cont_001"
  protected $customer_external_id => string(12) "customer_001"
  protected $first_name => string(4) "Adam"
  protected $last_name => string(5) "Smith"
  protected $position => int(1)
  protected $email => string(16) "[email protected]"
  protected $title => string(3) "CEO"
  protected $notes => string(19) "Heading\nBody\nFooter"
  protected $phone => string(11) "+1234567890"
  protected $linked_in => string(28) "https://linkedin.com/example"
  protected $twitter => string(27) "https://twitter.com/example"
  protected $custom => array(2) {
    "Facebook" => string(35) "https://www.facebook.com/adam.smith"
    "date_of_birth" => string(10) "1985-01-22"
  }
}
(*chartmogul.Contact)(0x14000268000)({
  UUID: (string) (len=40) "con_653af916-dea0-11ed-845b-3be1ac0039ac",
  CustomerExternalID: (string) (len=12) "customer_001",
  CustomerUUID: (string) (len=40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  DataSourceUUID: (string) (len=39) "ds_35542640-d9f1-11ed-9c30-7727168c74a5",
  ExternalID: (string) (len=8) "cont_001",
  FirstName: (string) (len=4) "Adam",
  LastName: (string) (len=5) "Smith",
  LinkedIn: (string) (len=29) "https://linkedin.com/example",
  Notes: (string) (len=19) "Heading\nBody\nFooter",
  Phone: (string) (len=11) "+1234567890",
  Position: (uint32) 1,
  Title: (string) (len=3) "CEO",
  Twitter: (string) (len=27) "https://twitter.com/example",
  Custom: (map[string]interface {}) (len=2) {
    (string) (len=8) "Facebook": (string) (len=35) "https://www.facebook.com/adam.smith",
    (string) (len=13) "date_of_birth": (string) (len=10) "1985-01-22"
  }
})
<Contact{
  custom={"Facebook": "https://www.facebook.com/adam.smith","date_of_birth": "1985-01-22"},
  customer_external_id="external_001",
  customer_uuid="cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0",
  data_source_uuid="ds_35542640-d9f1-11ed-9c30-7727168c74a5",
  external_id="cont_001",
  email="[email protected]",
  first_name="Adam",
  last_name="Smith",
  linked_in="https://linkedin.com/example",
  notes="Heading\nBody\nFooter",
  phone="+1234567890",
  position=9,
  title="CEO",
  twitter="https://twitter.com/example"
  uuid="con_653af916-dea0-11ed-845b-3be1ac0039ac"
}>

Path parameters

contact_uuid string required
The ChartMogul UUID of the contact you're retrieving

Query parameters

with_overrides boolean optional default: false
When true, the response includes an overrides object flagging the contact’s currently overridden fields.
attributes_with_history string optional
A comma-separated list of contact field names: first_name, last_name, email, title, phone, linked_in, twitter, or notes. The response then includes a historical_values object with the edit history of each listed field. Contact custom attributes are not supported. Unknown names fail the request with a 422.

Response

In the response, the JSON object contains the following data:

uuid
The UUID of the contact.
customer_uuid
The UUID of the customer to which this contact belongs.
customer_external_id
The external id of the customer to which this contact belongs.
data_source_uuid
The UUID of the source of the customer to which this contact belongs. A team member can have multiple sources, and the contact should only be associated to one of them.
external_id
The unique external identifier for this contact, as specified by you.
position
Position of the contact in the customer’s page.
first_name
The first name of the contact.
last_name
The last name of the contact.
title
The job title of the contact, e.g. "CEO".
email
The email address of the contact.
phone
The phone number of the contact.
linked_in
The URL of the contact's LinkedIn profile.
twitter
The URL of the contact's Twitter profile.
notes
Additional notes or comments about the contact.
last_seen
A timestamp of when the contact was last active, in the ISO 8601 format. Currently unavailable for our client libraries.
custom
A dictionary of custom attributes for the contact. If no custom attributes are set to a contact, this will be an empty object.
overrides
An object flagging the contact’s currently overridden fields with true, e.g. {"title": true}. Overridden values are protected from being overwritten by updates from your billing system. Fields are overridden from the ChartMogul UI or with the overrides parameter of the contact write endpoints. Only included when with_overrides is true.
historical_values
Up to the 10 most recent edit history entries per field named in attributes_with_history, newest first. Each entry carries the field’s value at that point, update_performed_at, update_performed_by (a team member’s name, an integration’s name, or API), and initial — true on the entry holding the field’s initial value, whose update_performed_at and update_performed_by are null. Values that an override blocked also appear: the attempt is recorded in the edit history even though it was never applied, and removing the override reverts to the latest recorded value. Only included when attributes_with_history is given.