v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Conversations

Messages

Get all messages for a dashboard.

Retrieves the text messages sent and received in the specified dashboard. Optionally, can provide a start and end date to filter the message history by. Messages will always be sorted from oldest to newest

get/dashboards/{dashboard_id}/messages

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

Query parameters

start_datestring date-time

Start date to filter messages in this dashboard by

end_datestring date-time

End date to filter messages in this dashboard by

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

Response

Messages in the conversation.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "message_id": "eb2a0cc2-5b88-468b-b3f4-926b07bcb275",
      "body": "I am reaching back out.",
      "message_direction": "S",
      "response_by_username": "John Doe",
      "delivery_status": "sending",
      "schedule_date_utc": "2026-07-15T14:30:00Z",
      "delivery_error": "2005",
      "mms_media": [
        "https://textrequeststorage.com/182739/3fd60fc2-1759-4dee-ac6f-4a97b994b84f.jpeg",
        "https://textrequeststorage.com/182739/c89c8c6a-8883-44cd-b833-f8b4dc8fbba4.png"
      ],
      "dashboard_phone": "14235613652",
      "customer_phone": "14252335575",
      "segments_count": 2
    }
  ]
}