Messaging

Get conversation prospect

Returns a list of prospects that have active conversation

get/conversations

Request

Base URL: http://bonzo.site/api/v3
URL: http://bonzo.site/api/v3/conversations
Auth: HTTP bearer

Query parameters

assigned_tostring

Example:1

do_not_callboolean

include_conversationlistboolean

searchstring

Example:John

show_allboolean

show_all_teamsboolean

view'all' | 'unread' | 'snoozed'

Example:unread

per_pageinteger

pageinteger

Response

Success

Example response

{
  "data": [
    {
      "avatar": "https://via.placeholder.com/128x128",
      "full_name": "John Doe",
      "email": "johndoe@example.com",
      "email_type": "valid",
      "phone": "1112223333",
      "phone_type": "valid",
      "last_contact": "2022-01-01T01:00:00.000000Z",
      "last_outgoing_message": "Example message",
      "last_incoming_message": "Example message"
    }
  ],
  "links": {
    "first": "https://example.com?page=1",
    "last": "https://example.com?page=3",
    "next": "https://example.com?page=2"
  },
  "meta": {
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://example.com?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": "https://example.com?page=2",
        "label": 2,
        "active": false
      },
      {
        "url": "https://example.com?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.