POST GET contacts/lookup

Get full details for contacts by either contactID or email

* required

Parameters

Name Type Description
contactID integer Unique ID of a contact
contactIDs array[integer] Multiple contactIDs. Requests that use this parameter will change the response data from a single object to an array of objects.
100
email email-address An email address of an existing contact

Response Data

Returns a fully populated contact object, or an array of contact objects if looking up multiple contactIDs
Name Type Description
address1 string
address2 string
city string
company string
contactID integer Unique ID of a contact
contactScore struct Struct containing keys for "dateModified" and "value". e.g. {"dateModified":"2018-04-19 21:03:17","value":100}. If you have multiple contact scores, an additional key for each contact score will be included with a struct of "dateModified", "value", and "title" keys. This data is read-only and cannot be saved.
contentVariables struct Content variables 1 to 10. Each content variable is a struct with keys for "label" and "value". When saving, you only need to provide the value. e.g. {"content1":{"value":"My custom value"}}
country string
customerID string ID of record in client system
customFields struct Custom fields (1 to X). Use customFields/search endpoint to determine available custom fields for your account. Each custom field is a struct with keys for "label" and "value". When saving, you only need to provide the value. e.g. {"custom1":{"value":"My custom value"}} For existing records, fields not passed in will remain unchanged.
dateAdded datetime Date record was added
dateHeld datetime Date record was held
dateModified datetime Date record was modified
dateOfBirth date Full date of birth in yyyy-mm-dd format. To use only month and day, use 1900 as year
dateSuppressed datetime Date record was suppressed
email email-address A valid email address
fax string
firstName string
groupIDs array[integer] Groups contact is subscribed to. Excludes groups where contact is suppressed.
held boolean Bad email address (too many bounces)
ipAddress string Source IP of record
lastActivityDate datetime Date contact last viewed an email
lastClickDate datetime Date contact last clicked a link in an email
lastName string
memo string
notes string Extra details about record (internal use)
originalSource string Client-specified source of record
phone string
purl string Personal URL (PURL) used with emfluence Marketing Platform landing pages. PURLs must be unique per contact. PURLs can contain only letters, numbers, and any of the following characters: .-_!
state string
suppressed boolean Opted out of receiving emails
title string
userID integer ID of system user contact belongs to
zipCode string

Permissions

Method requires the Contacts (Edit) permission

Example Calls

Lookup contact by ID

GET
/contacts/lookup?contactID=123
cURL
Copy
Response Data

Lookup contact by email

Demonstrates doing a POST passing parameters as JSON in the request body

POST
/contacts/lookup
cURL
Copy

Lookup multiple contacts by array of contactIDs

POST
/contacts/lookup
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
GET
contacts/lookup
Param Value Type Description
contactID integer Unique ID of a contact
contactIDs array[integer] Multiple contactIDs. Requests that use this parameter will change the response data from a single object to an array of objects.
100
email email-address An email address of an existing contact
Access token: *