HomeSandbox AccountsAPI DocumentationApp StudioWebhooksCommunity
API Documentation

Retrieve a contact

get https://{youraccountname}.api-us1.com/api/3/contacts/

Retrieve an existing contact

❗️

created_utc_timestamp and updated_utc_timestamp are US/Central Time, not UTC

created_utc_timestamp and updated_utc_timestamp are not actually UTC-time, these values are returned in US/Central Time.

🚧

mpp_tracking Has Been Deprecated

Some fields returned by the API are undocumented, and may be deprecated or removed without notice.

🚧

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account Contact endpoints.

{
  "contactAutomations": [
    {
      "contact": "1",
      "seriesid": "1",
      "startid": "0",
      "status": "0",
      "adddate": "1976-10-16T23:23:09-05:00",
      "remdate": null,
      "timespan": null,
      "lastblock": "0",
      "lastdate": "1984-08-15T08:13:44-05:00",
      "completedElements": "0",
      "totalElements": "0",
      "completed": 0,
      "completeValue": 100,
      "links": {
        "automation": "https://:account.api-us1.com/api/3/contactAutomations/1/automation",
        "contact": "https://:account.api-us1.com/api/3/contactAutomations/1/contact",
        "contactGoals": "https://:account.api-us1.com/api/3/contactAutomations/1/contactGoals"
      },
      "id": "1",
      "automation": "1"
    }
  ],
  "contactLists": [
    {
      "contact": "1",
      "list": "1",
      "form": null,
      "seriesid": "0",
      "sdate": null,
      "udate": null,
      "status": "1",
      "responder": "1",
      "sync": "0",
      "unsubreason": null,
      "campaign": null,
      "message": null,
      "first_name": "John",
      "last_name": "Doe",
      "ip4Sub": "0",
      "sourceid": "0",
      "autosyncLog": null,
      "ip4_last": "0",
      "ip4Unsub": "0",
      "unsubscribeAutomation": null,
      "links": {
        "automation": "https://:account.api-us1.com/api/3/contactLists/1/automation",
        "list": "https://:account.api-us1.com/api/3/contactLists/1/list",
        "contact": "https://:account.api-us1.com/api/3/contactLists/1/contact",
        "form": "https://:account.api-us1.com/api/3/contactLists/1/form",
        "autosyncLog": "https://:account.api-us1.com/api/3/contactLists/1/autosyncLog",
        "campaign": "https://:account.api-us1.com/api/3/contactLists/1/campaign",
        "unsubscribeAutomation": "https://:account.api-us1.com/api/3/contactLists/1/unsubscribeAutomation",
        "message": "https://:account.api-us1.com/api/3/contactLists/1/message"
      },
      "id": "1",
      "automation": null
    }
  ],
  "deals": [
    {
      "owner": "1",
      "contact": "1",
      "organization": null,
      "group": null,
      "title": "Consectetur omnis quo inventore molestiae ratione amet.",
      "nexttaskid": "0",
      "currency": "USD",
      "status": "0",
      "links": {
        "activities": "https://:account.api-us1.com/api/3/deals/1/activities",
        "contact": "https://:account.api-us1.com/api/3/deals/1/contact",
        "contactDeals": "https://:account.api-us1.com/api/3/deals/1/contactDeals",
        "group": "https://:account.api-us1.com/api/3/deals/1/group",
        "nextTask": "https://:account.api-us1.com/api/3/deals/1/nextTask",
        "notes": "https://:account.api-us1.com/api/3/deals/1/notes",
        "organization": "https://:account.api-us1.com/api/3/deals/1/organization",
        "owner": "https://:account.api-us1.com/api/3/deals/1/owner",
        "scoreValues": "https://:account.api-us1.com/api/3/deals/1/scoreValues",
        "stage": "https://:account.api-us1.com/api/3/deals/1/stage",
        "tasks": "https://:account.api-us1.com/api/3/deals/1/tasks"
      },
      "id": "1",
      "nextTask": null
    }
  ],
  "fieldValues": [
    {
      "contact": "1",
      "field": "1",
      "value": null,
      "cdate": "1981-05-16T19:02:29-05:00",
      "udate": "1975-11-08T10:31:45-06:00",
      "links": {
        "owner": "https://:account.api-us1.com/api/3/fieldValues/1/owner",
        "field": "https://:account.api-us1.com/api/3/fieldValues/1/field"
      },
      "id": "1",
      "owner": "1"
    }
  ],
  "geoAddresses": [
    {
      "ip4": "823",
      "country2": "AS",
      "country": "Suriname",
      "state": "KY",
      "city": "North Arnoldomouth",
      "zip": "38704-6592",
      "area": "0",
      "lat": "-70.160407",
      "lon": "-102.229406",
      "tz": "Europe/Chisinau",
      "tstamp": "1972-03-16T07:26:58-06:00",
      "links": [
        
      ],
      "id": "1"
    }
  ],
  "geoIps": [
    {
      "contact": "1",
      "campaignid": "1",
      "messageid": "1",
      "geoaddrid": "1",
      "ip4": "0",
      "tstamp": "1988-08-05T11:50:51-05:00",
      "geoAddress": "1",
      "links": {
        "geoAddress": "https://:account.api-us1.com/api/3/geoIps/1/geoAddress"
      },
      "id": "1"
    }
  ],
  "contact": {
    "cdate": "2007-05-05T12:49:09-05:00",
    "email": "[email protected]",
    "phone": "",
    "firstName": "Charles",
    "lastName": "Reynolds",
    "orgid": "0",
    "segmentio_id": "",
    "bounced_hard": "0",
    "bounced_soft": "0",
    "bounced_date": null,
    "ip": "0",
    "ua": null,
    "hash": "",
    "socialdata_lastcheck": null,
    "email_local": "",
    "email_domain": "",
    "sentcnt": "0",
    "rating_tstamp": null,
    "gravatar": "0",
    "deleted": "0",
    "adate": null,
    "udate": null,
    "edate": null,
    "contactAutomations": [
      "1"
    ],
    "contactLists": [
      "1"
    ],
    "fieldValues": [
      "1"
    ],
    "geoIps": [
      "1"
    ],
    "deals": [
      "1"
    ],
    "accountContacts": [
      "1"
    ],
    "links": {
      "bounceLogs": "https://:account.api-us1.com/api/3/contacts/1/bounceLogs",
      "contactAutomations": "https://:account.api-us1.com/api/3/contacts/1/contactAutomations",
      "contactData": "https://:account.api-us1.com/api/3/contacts/1/contactData",
      "contactGoals": "https://:account.api-us1.com/api/3/contacts/1/contactGoals",
      "contactLists": "https://:account.api-us1.com/api/3/contacts/1/contactLists",
      "contactLogs": "https://:account.api-us1.com/api/3/contacts/1/contactLogs",
      "contactTags": "https://:account.api-us1.com/api/3/contacts/1/contactTags",
      "contactDeals": "https://:account.api-us1.com/api/3/contacts/1/contactDeals",
      "deals": "https://:account.api-us1.com/api/3/contacts/1/deals",
      "fieldValues": "https://:account.api-us1.com/api/3/contacts/1/fieldValues",
      "geoIps": "https://:account.api-us1.com/api/3/contacts/1/geoIps",
      "notes": "https://:account.api-us1.com/api/3/contacts/1/notes",
      "organization": "https://:account.api-us1.com/api/3/contacts/1/organization",
      "plusAppend": "https://:account.api-us1.com/api/3/contacts/1/plusAppend",
      "trackingLogs": "https://:account.api-us1.com/api/3/contacts/1/trackingLogs",
      "scoreValues": "https://:account.api-us1.com/api/3/contacts/1/scoreValues"
    },
    "id": "1",
    "organization": null
  }
}
Language
Credentials
Header
URL