Skip to content
LeadPattern
Reference/Broadcast Groups/List Broadcast Groups

List Broadcast Groups

GEThttps://public.leadpattern.com/groups
Plan: broadcastapplication/json60 req/min

Retrieve broadcast groups with cursor-based pagination. Supports search, ordering by name or creation date.

  • Page size is fixed at 20.
  • Cursor paging: send all three afterX params together.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Query Parameters

6 fields
searchQuerystring
optional
Filter groups by name.
orderByenum
optionaldefault: DATE_CREATED
Sort field.
Allowed values:
NAMEDATE_CREATED
formatenum
optionaldefault: DESCENDING
Sort direction.
Allowed values:
ASCENDINGDESCENDING
afterGroupIdstring
optional
Cursor: id of last group from previous page.
afterGroupNamestring
optional
Cursor: name of last group from previous page.
afterDateCreatedstring
optional
Cursor: createdAt of last group (ISO 8601).

Responses

JSON Response
{
  "type": "success",
  "data": {
    "groups": [
      {
        "groupId": "664abc...",
        "groupChatName": "VIP Customers",
        "memberCount": 150,
        "dateCreated": "2026-05-01T08:00:00.000Z"
      }
    ],
    "paginationParams": null
  }
}

Sample Request

{
  "searchQuery": "(optional)",
  "orderBy": "NAME | DATE_CREATED",
  "format": "ASCENDING | DESCENDING",
  "afterGroupId": "(cursor, optional)",
  "afterGroupName": "(cursor, optional)",
  "afterDateCreated": "(cursor, optional)"
}
← Previous Endpoint
Create Broadcast Group
Next Endpoint →
Add Members to Group