v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB

Broadcast Groups

Get paginated groups

Returns a list of paginated groups based on search criteria and pagination parameters

get/groups

Query parameters

searchQuerystring

Search query

Example:group name

The search query to filter groups

orderBy'NAME' | 'DATE_CREATED'

Order by

Example:NAME

The field to order the groups by

format'ASCENDING' | 'DESCENDING' | 'ascending' | 'descending'

Order format

Example:ASCENDING

The order format to apply to the groups

afterGroupIdstring

Group ID after which the groups are to be fetched

Example:group_id

The group ID to fetch the groups after

afterGroupNamestring

Group name after which the groups are to be fetched

Example:group_name

The group name to fetch the groups after

afterDateCreatedstring date-time

Group date created after which the groups are to be fetched

Example:2020-01-01T00:00:00.000Z

The group creation date to fetch the groups after

Response

Example response

{
  "groups": [
    {
      "groupId": "group_id",
      "groupChatId": "group_chat_id",
      "groupChatName": "group_name",
      "canManageGroupAccess": true,
      "groupAccessLevel": "NO_ACCESS"
    }
  ],
  "paginationParams": {
    "afterGroupId": "group_id",
    "afterGroupName": "group_name",
    "afterDateCreated": "2020-01-01T00:00:00.000Z"
  }
}