List conversations

GET

https://api.mailchimp.com/3.0/conversations

GET

/3.0/conversations

curl https://api.mailchimp.com/3.0/conversations \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "conversations": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "campaign_id": "string",
      "from_email": "string",
      "from_label": "string",
      "id": "string",
      "last_message": {
        "from_email": "string",
        "from_label": "string",
        "message": "string",
        "read": true,
        "subject": "string",
        "timestamp": "2024-01-15T09:30:00Z"
      },
      "list_id": "string",
      "message_count": 1,
      "subject": "string",
      "unread_messages": 1
    }
  ],
  "total_items": 1
}

Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don’t include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

has_unread_messagesenumOptional

Whether the conversation has any unread messages.

Allowed values:

list_idstringOptional

The unique id for the list.

campaign_idstringOptional

The unique id for the campaign.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

conversationslist of objectsOptional

A list of conversations.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.