POST GET exports/contacts

Export contact data

* required

Parameters

Name Type Description
groupID integer Return contacts in a given group
lastActivityDate datetime Date since contacts viewed or clicked any email
fields string Comma-separated list of fields to return. Available fields: address1, address2, city, company, contactID, content1, content2, content3, country, custom1, custom2, ...custom20, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode
contactID, userID, email, firstName, lastName, suppressed, held, dateAdded

Response Data

Name Type Description
jobID integer ID of export job. Use to check the status of the job at /exports/jobStatus

Permissions

Method requires the Client Administrator permission

Example Calls

All contacts in a group

GET
/exports/contacts?groupID=123
cURL
Copy
Response Data

Recently active contacts

GET
/exports/contacts?lastActivityDate=2020-07-29
cURL
Copy
Response Data

Report Columns

Name Type Description
contactID integer ID of contact record
userID integer ID of user that owns contact
email string Email address of contact record
firstName string
lastName string
suppressed boolean Has contact opted out?
held boolean Has email bounced?
dateAdded datetime Date record added

Sample Report

This is a sample of the export file that will be generated. Read more about the export file format.

"contactID"	"userID"	"email"	"firstName"	"lastName"	"suppressed"	"held"	"dateAdded"
123	1000	"john.doe@example.com"	"John"	"Doe"	0	0	"2014-02-12 00:42:00"
456	1000	"jane.doe@example.com"	"Jane"	"Doe"	0	0	"2014-01-12 06:15:00"

API Console

The console uses production data, so BE CAREFUL!
GET
exports/contacts
Param Value Type Description
groupID integer Return contacts in a given group
lastActivityDate datetime Date since contacts viewed or clicked any email
fields string Comma-separated list of fields to return. Available fields: address1, address2, city, company, contactID, content1, content2, content3, country, custom1, custom2, ...custom20, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode
contactID, userID, email, firstName, lastName, suppressed, held, dateAdded
Access token: *