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.
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 can send to this group

Permissions

Method requires the Create Groups permission

Example Calls

Lookup group by ID

GET
/groups/lookup?groupID=123
cURL
Copy
Response Data

Lookup multiple groups by array of groupIDs

POST
/groups/lookup
cURL
Copy
Response Data

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.
25
Access token: *