SubscriberGroups
Search SubscriberGroups
Search and list SubscriberGroup records with filtering, sorting, and pagination.
GET
Search SubscriberGroups
A newsletter subscriber group (SubscriberGroup) is a location-scoped audience segment for organising newsletter subscribers, either manually or through scheduled rules for members, contacts, attendees, visitors, and booking customers.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the SubscriberGroup-List role.Query Parameters
Pagination & Sorting
Filters
Filter by required, unique name used to identify this newsletter subscriber group within the location..
Filter by whether the smart group automatically includes current members; enabled member criteria are reconciled on the smart-group update cycle..
Filter by whether the smart group automatically includes current contacts, meaning customers without an active contract..
Filter by whether this is a system-created membership group managed from location settings; read-only groups cannot be edited manually..
Range Filters
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of SubscriberGroup records matching the query. See the Get one SubscriberGroup endpoint for the full list of properties returned for each record.
Example Response