v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Scheduled Messages

Lists scheduled 1:1 messages.

Returns all pending scheduled 1:1 messages for a dashboard. Excludes group messages. Each item's message_id is the value returned when the message was scheduled via POST /messages or POST /dashboards/{dashboard_id}/contacts/{phone_number}/messages.

get/dashboards/{dashboard_id}/scheduledmessages

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

Return only messages whose next send time is after this UTC timestamp.

schedule_date_beforestring date-time

Return only messages whose next send time is before this UTC timestamp.

recurring_onlyboolean

If true, return only recurring scheduled messages. Defaults to false if omitted.

Response

Scheduled 1:1 messages for this dashboard.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "message_id": "eb2a0cc2-5b88-468b-b3f4-926b07bcb275",
      "status": "scheduled",
      "body": "Reminder: your appointment is tomorrow.",
      "to": "14239309346",
      "date_created": "2026-08-01T12:00:00Z",
      "schedule_date_utc": "2026-08-15T14:00:00Z",
      "occurrence_number": 1,
      "repeat_settings": {
        "repeat_by": "week",
        "step": 1,
        "times": 5,
        "end_date": "2026-12-31T23:59:59Z",
        "days": [
          "Monday",
          "Wednesday"
        ]
      }
    }
  ]
}