POST GET contacts/search

Search contacts by various criteria

* required

Parameters

Name Type Description
groupID integer Filter results by group
suppressed boolean Opted out of receiving emails
held boolean Bad email address (too many bounces)
contactIDs array[integer] Multiple contactIDs
100
email string Search by email address. Use * as a wildcard, e.g. *@gmail.com
userID integer Returns contacts owned by this user
customerID string ID of record in client system
lastName string
company string
title string
phone string
fax string
city string
state string
zipCode string
country 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: .-_!
dobMonth integer Month number for date of birth (1-12)
1
12
dobDay integer Day number for date of birth (1-31)
1
31
dobYear integer 4-digit year for date of birth
1900
2019
lastActivityDateStart datetime Start date of when contacts viewed or clicked any email
lastActivityDateEnd datetime End date of when contacts viewed or clicked any email
lastActivityType string Filter contact activity positivly (active) or negatively (inactive). Use with lastActivityDateStart and lastActivityDateEnd
active
active, inactive
lastClickDateStart datetime Start date of when contacts clicked any email
lastClickDateEnd datetime End date of when contacts clicked any email
lastClickType string Filter contact click activity positivly (active) or negatively (inactive). Use with lastClickDateStart and lastClickDateEnd
active
active, inactive
dateAddedStart datetime Start date of when contacts were added
dateAddedEnd datetime End date of when contacts were added
dateModifiedStart datetime Start date of when contacts were last modified
dateModifiedEnd datetime End date of when contacts were last modified
fields string Comma-separated list of fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX
contactID, userID, email, firstName, lastName, suppressed, held, dateAdded, dateModified
page integer Number of page in results to return
1
1
rpp integer Number of records to return per page
20
1
1000
sortField string The field to sort results by
email
contactID, email, dateModified, contactScore
sortDirection string The direction to sort results
asc
asc, desc
custom1 - customX varies Custom fields (1 to X). Custom fields are defined per account so the number of fields as well as the data type of each field will vary. Make a call to the customFields/search endpoint for more information.

Response Data

Response data can be controlled by the "fields" parameter.
Name Type Description
contactID integer Unique ID of a contact
userID integer ID of system user contact belongs to
email email-address A valid email address
firstName string
lastName string
suppressed boolean Opted out of receiving emails
held boolean Bad email address (too many bounces)
dateAdded datetime Date record was added
dateModified datetime Date record was modified

Example Calls

All contacts

GET
/contacts/search
cURL
Copy
Response Data

Contacts with @gmail.com email addresses

GET
/contacts/search?email=*@gmail.com
cURL
Copy

Inactive contacts

GET
/contacts/search?lastActivityDateStart=2019-08-14&lastActivityType=inactive
cURL
Copy

Return specific fields

GET
/contacts/search?fields=email,custom1
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
GET
contacts/search