Conversations

List conversations

Changed on

Lists inbox conversations: replies to your campaigns, sequences, and transactional email, plus email sent to your inbox address. Filter by status, unread flag, search term, inbox address, or the Spam folder. Conversations in the Spam folder are only listed with spam=true.

get/conversations

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/conversations
  • Auth
    HTTP bearer

Query parameters

status'all' | 'open' | 'closed'

Filter by conversation status.

searchstring

Search in subject, subscriber email, or subscriber name.

pageinteger

Page number.

limitinteger

Results per page.

unread'true'

Pass "true" to only return conversations with unread messages.

spam'true' | 'false'

Pass "true" to list the Spam folder instead. Other lists leave spam out.

recipientstring email

Only conversations that started at this inbox address. Case does not matter. See List conversation recipients.

Response

Conversations returned

successboolean

Example response

{
  "success": true,
  "conversations": [
    {
      "id": "conv_abc123",
      "lastMessageBy": "subscriber",
      "lastMessagePreview": {
        "text": "Thanks, Thursday works for me."
      },
      "context": {
        "type": "campaign"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the new optional query request parameter recipient

    • info

      added the new optional query request parameter spam

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status