v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Conversations

Retrieves all conversations for this dashboard.

Retrieves the last message across all conversations in this dashboard.

get/dashboards/{dashboard_id}/conversations

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Query parameters

tagsstring

List or singular guid referencing the contact tags you want to filter by

show_unresolved_onlyboolean
include_archivedboolean
searchstring

Search term for filtering conversations by phone number or display name. If the search term is less than a full name or phone number, the search will return all conversations that partially match it.

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

Conversations.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "phone_number": "13216547890",
      "last_message": {
        "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"
        ]
      }
    }
  ]
}