POST GET groups/getContacts

Get subscription data for contacts in a static group

* required

Parameters

Name	Type	Description
groupID *	integer	Unique ID of a group
suppressed	boolean	Opted out of receiving emails for the group
dateAddedStart	datetime	Start date of when contacts were added to the group
dateAddedEnd	datetime	End date of when contacts were added to the group
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000

Response Data

Name	Type	Description
contactID	integer	ID of contact
email	string
suppressed	boolean	Contact has opted out of receiving emails for the group
dateAdded	datetime	Date the contact was added to the group
dateSuppressed	datetime	Date contact was suppressed in the group

Permissions

Method requires the Contacts (Edit) permission

Example Calls

Get suppressed contacts

GET

/groups/getContacts?groupID=123&suppressed=1

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/getContacts?groupID=123&suppressed=1 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"code":0,"data":{"records":[{"dateAdded":"2019-08-13 22:30:00","email":"john.doe@example.com","contactID":123,"dateSuppressed":"2019-08-13 22:30:00","suppressed":1},{"dateAdded":"2019-08-13 22:30:00","email":"john.doe@example.com","contactID":456,"dateSuppressed":"2019-08-13 22:30:00","suppressed":1}],"paging":{"rpp":100,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":2}},"requestID":"6214AF0C-DBEF-4741-B3A7A58EA52E800E"}

Get contacts added between two dates

GET

/groups/getContacts?groupID=123&dateAddedStart=2019-12-01&dateAddedEnd=2019-12-08

cURL

Copy

curl https://api.emailer.emfluence.com/v1/groups/getContacts?groupID=123&dateAddedStart=2019-12-01&dateAddedEnd=2019-12-08 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"code":0,"data":{"records":[{"dateAdded":"2019-08-13 22:30:00","email":"john.doe@example.com","contactID":123,"dateSuppressed":"","suppressed":0},{"dateAdded":"2019-08-13 22:30:00","email":"john.doe@example.com","contactID":456,"dateSuppressed":"2019-08-13 22:30:00","suppressed":1}],"paging":{"rpp":100,"totalPages":1,"prev":"","next":"","page":1,"totalRecords":2}},"requestID":"7B031D1D-21DF-4A10-B52D1DE3C908E700"}

API Console

The console uses production data, so BE CAREFUL!

GET

groups/getContacts

Param	Type	Description
groupID *	integer	Unique ID of a group
suppressed	boolean	Opted out of receiving emails for the group
dateAddedStart	datetime	Start date of when contacts were added to the group
dateAddedEnd	datetime	End date of when contacts were added to the group
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000

Access token: *

Groups

POST GET groups/getContacts

Parameters

Response Data

Permissions

Example Calls

Get suppressed contacts

Get contacts added between two dates

API Console