Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Group Messages

Retrieves all group messages.

This includes just the basic details of each group message. For greater send detail, see GET /groupmessages/{id}

get/dashboards/{dashboard_id}/groupmessages

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Query parameters

pageinteger

The page number. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned. The first item returned will be page multiplied by page_size

schedule_date_afterstring date-time
schedule_date_beforestring date-time
date_created_afterstring date-time
date_created_beforestring date-time
recurring_onlyboolean

Whether to return only scheduled recurring messages. Defaults to false if not included

Response

All group messages for this dashboard in a list.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "id": "95c63493-acc5-41b5-82b6-5f7de97cf9d9",
      "status": "sending",
      "body": "Don't forget the Family and Friends sale at our Toledo location on 6-15-2021 at 8:00PM!",
      "date_created": "2022-01-12T19:19:11.8032151Z",
      "total": 40,
      "sent": 31,
      "successfully_sent": 24,
      "schedule_date_utc": "2023-01-12T19:19:11.8032151Z",
      "mms_media": [
        "https://textrequeststorage.com/182739/3fd60fc2-1759-4dee-ac6f-4a97b994b84f.jpeg",
        "https://textrequeststorage.com/182739/c89c8c6a-8883-44cd-b833-f8b4dc8fbba4.png"
      ],
      "occurrence_number": 1,
      "repeat_settings": {
        "repeat_by": "week",
        "step": 1,
        "times": 5,
        "end_date": "2026-12-31T23:59:59Z",
        "days": [
          "Monday",
          "Wednesday"
        ]
      }
    }
  ]
}