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. Max: 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", "value", and "percentile". e.g. {"dateModified":"2018-04-19 21:03:17","value":100,"percentile":48}. If you have multiple contact scores, an additional key for each contact score will be included with a struct of "dateModified", "value", "percentile", 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
mobileNumber	string	A valid phone number used for SMS. Return values will be in E.164 format (e.g. +15551234567)
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: .-_!
smsOptOut	array	SMS opt out details for the contact's mobile number
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

curl https://api.emailer.emfluence.com/v1/contacts/lookup?contactID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"customerID":"JDOE123","address2":"","memo":"","address1":"","content2":"","content1":"","content3":"","fax":"","company":"","dateAdded":"2013-05-17 16:59:00","purl":"","dateSuppressed":"","zipCode":64105,"originalSource":"","city":"Kansas City","lastName":"Doe","userID":10,"state":"MO","mobileNumber":"+18165555555","phone":"816-555-5555","firstName":"John","dateHeld":"","email":"john.doe@example.com","notes":"","suppressed":0,"country":"","dateModified":"2014-02-22 04:02:00","contactID":123,"held":0,"dateOfBirth":"1985-09-15","groupIDs":[123,456],"customFields":{"custom1":{"label":"Custom 1","value":"Male"},"custom2":{"label":"Custom 2","value":"2015-04-16"}},"title":"","contactScore":{"dateModified":"2018-04-19 21:03:17","value":100}},"code":0,"requestID":"76BF1554-2D43-46C0-ACCAD24B6AA6E2D8"}

Lookup contact by email

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

POST

/contacts/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"email": "john.doe@example.com"
	}'

Lookup multiple contacts by array of contactIDs

POST

/contacts/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/contacts/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"contactIDs": [123,456,789]
	}'

Response Data

{"success":1,"data":[{"customerID":"JDOE123","address2":"","memo":"","address1":"","content2":"","content1":"","content3":"","fax":"","company":"","dateAdded":"2013-05-17 16:59:00","purl":"","dateSuppressed":"","zipCode":64105,"originalSource":"","city":"Kansas City","lastName":"Doe","userID":10,"state":"MO","mobileNumber":"+18165555555","phone":"816-555-5555","firstName":"John","dateHeld":"","email":"john.doe@example.com","notes":"","suppressed":0,"country":"","dateModified":"2014-02-22 04:02:00","contactID":123,"held":0,"dateOfBirth":"1985-09-15","groupIDs":[123,456],"customFields":{"custom1":{"label":"Custom 1","value":"Male"},"custom2":{"label":"Custom 2","value":"2015-04-16"}},"title":"","contactScore":{"dateModified":"2018-04-19 21:03:17","value":100}},{"customerID":"JDOE456","address2":"","memo":"","address1":"","content2":"","content1":"","content3":"","fax":"","company":"","dateAdded":"2013-07-10 13:11:00","purl":"","dateSuppressed":"","zipCode":64105,"originalSource":"","city":"Kansas City","lastName":"Doe","userID":10,"state":"MO","mobileNumber":"+18165555555","phone":"816-555-5555","firstName":"Jane","dateHeld":"","email":"jane.doe@example.com","notes":"","suppressed":0,"country":"","dateModified":"2014-04-15 08:34:00","contactID":456,"held":0,"dateOfBirth":"1983-03-07","groupIDs":[123,456],"customFields":{"custom1":{"label":"Custom 1","value":"Female"},"custom2":{"label":"Custom 2","value":"2015-06-10"}},"title":"","contactScore":{"dateModified":"2018-04-19 21:03:17","value":100}},{"customerID":"BSMITH789","address2":"","memo":"","address1":"","content2":"","content1":"","content3":"","fax":"","company":"","dateAdded":"2014-03-28 15:17:00","purl":"","dateSuppressed":"","zipCode":64105,"originalSource":"","city":"Kansas City","lastName":"Smith","userID":10,"state":"MO","mobileNumber":"+18165555555","phone":"816-555-5555","firstName":"Bob","dateHeld":"","email":"bob.smith@example.com","notes":"","suppressed":0,"country":"","dateModified":"2014-08-01 15:12:00","contactID":789,"held":0,"dateOfBirth":"1980-11-29","groupIDs":[123,456],"customFields":{"custom1":{"label":"Custom 1","value":"Male"},"custom2":{"label":"Custom 2","value":"2015-06-01"}},"title":"","contactScore":{"dateModified":"2018-04-19 21:03:17","value":100}}],"code":0,"requestID":"F1D727F0-21BF-45DE-AB61506FF193D6F0"}

API Console

The console uses production data, so BE CAREFUL!

GET

contacts/lookup

Param	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. Max: 100
email	email-address	An email address of an existing contact

Access token: *