POST GET groups/lookup

Get full details for groups

* required

Parameters

Name	Type	Description
groupID	integer	Unique ID of a group
groupIDs	array[integer]	Multiple groupIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25

Response Data

Returns a fully populated group object, or an array of group objects if looking up multiple groupIDs

Name	Type	Description
activeMembers	integer	Number of active (not held/suppressed) contacts in group
autoResponseEmailID	integer	ID of email contacts will receive when added to group
dateAdded	datetime	Date record was added
dateLastEmailSent	datetime	Date group was last sent an email
dateModified	datetime	Date record was modified
description	string	Description of group. Displayed to contacts on preferences page.
externalID	string	ID of record in client system
friendlyName	string	Name displayed to contacts on preferences page. Defaults to groupName
groupID	integer	Unique ID of a group
groupName	string	Name of group. Must be unique
notes	string	Extra information about group. For internal use only.
private	boolean	Do not display this group on contact preferences page
protected	boolean	Protected groups cannot be archived or deleted. Groups that are populated from external sources should be marked as protected.
sendTests	boolean	Group can be used for sending test emails
status	string	One of: Active, Archived. Archived groups are hidden by default.
totalMembers	integer	Total number of contacts in group
type	string	One of: Static, Dynamic. Dynamic groups cannot have contacts added to them because their members are determined by a query.
userID	integer	ID of system user group belongs to
userIDs	array[integer]	Users who have access to this group

Permissions

Method requires the Create Groups permission

Example Calls

Lookup group by ID

GET

/groups/lookup?groupID=123

cURL

Copy

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

Response Data

{"success":1,"data":{"groupName":"Retail Customers","dateAdded":"2014-02-12 00:42:00","status":"Active","friendlyName":"","totalMembers":255542,"activeMembers":240365,"dateLastEmailSent":"2015-02-12 00:42:00","description":"Complete list of retail customers","groupID":123,"userIDs":[123,456],"private":1,"test":0,"type":"Static","notes":"","protected":0,"dateModified":"","autoResponseEmailID":"","userID":""},"code":0,"requestID":"F1453B79-F59A-4A75-9E9DD68E8EBD4839"}

Lookup multiple groups by array of groupIDs

POST

/groups/lookup

cURL

Copy

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

Response Data

{"success":1,"data":[{"groupName":"API Example Group 1","status":"Active","friendlyName":"","totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2014-02-12 00:42:00","description":"API Example Group 1","groupID":123,"userIDs":[123,456],"private":1,"test":0,"type":"Static","notes":"","protected":0,"dateModified":"","autoResponseEmailID":"","userID":""},{"groupName":"API Example Group 2","status":"Active","friendlyName":"","totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2015-05-05 14:10:00","description":"API Example Group 2","groupID":456,"userIDs":[123,456],"private":1,"test":0,"notes":"","protected":0,"dateModified":"","autoResponseEmailID":"","userID":""},{"groupName":"API Example Group 3","status":"Active","friendlyName":"","totalMembers":1000,"activeMembers":500,"dateLastEmailSent":"2015-02-12 00:42:00","dateAdded":"2015-06-10 11:39:00","description":"API Example Group 3","groupID":789,"userIDs":[123,456],"private":1,"test":0,"notes":"","protected":0,"dateModified":"","autoResponseEmailID":"","userID":""}],"code":0,"requestID":"2E843935-6B7F-416B-92952F9F2BB0F468"}

API Console

The console uses production data, so BE CAREFUL!

GET

groups/lookup

Param	Value	Type	Description
groupID		integer	Unique ID of a group
groupIDs		array[integer]	Multiple groupIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25

Access token: *