POST GET groups/search
Search groups by various criteria
* required
Parameters
| Name | Type | Description |
|---|---|---|
| groupName | string | Matches any part of a group name (i.e. "customer" matches "Retail Customers") |
| status | string |
By default, archived groups are excluded from results. Pass "All" to match any status.
Active
Active, Archived, All
|
| groupIDs | array[integer] | Multiple groupIDs |
| userID | integer | Returns groups that this user has access to |
| private | boolean | Pass 0 to return groups displayed on contact preferences page |
| type | string |
All
Dynamic, Static, All
|
| page | integer |
Number of page in results to return
1
1
|
| rpp | integer |
Number of records to return per page
20
1
250
|
| sortField | string |
The field to sort results by
groupName
groupID, groupName, dateAdded, dateModified, dateLastEmailSent, totalMembers, activeMembers
|
| sortDirection | string |
The direction to sort results
asc
asc, desc
|
Response Data
| Name | Type | Description |
|---|---|---|
| groupID | integer | Unique ID of a group |
| groupName | string | Name of group. Must be unique |
| status | string | One of: Active, Archived. Archived groups are hidden by default. |
| friendlyName | string | Name displayed to contacts on preferences page. Defaults to groupName |
| description | string | Description of group. Displayed to contacts on preferences page. |
| private | boolean | Do not display this group on contact preferences page |
| userID | integer | ID of system user group belongs to |
| autoResponseEmailID | integer | ID of email contacts will receive when added to group |
| dateAdded | datetime | Date record was added |
| dateModified | datetime | Date record was modified |
| dateLastEmailSent | datetime | Date group was last sent an email |
| totalMembers | integer | Total number of contacts in group |
| activeMembers | integer | Number of active (not held/suppressed) 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. |
Permissions
Method requires the Create Groups permission
Example Calls
All active groups
GET
/groups/search
cURL
Copy
Response Data
Public groups
GET
/groups/search?private=0
cURL
Copy
Archived groups
GET
/groups/search?status=Archived
cURL
Copy
Groups with "Customer" in the name
GET
/groups/search?groupName=Customer
cURL
Copy
API Console
The console uses production data, so BE CAREFUL!
GET
groups/search