List messages

GET

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

GET

/3.0/conversations/:conversation_id/messages

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

200Retrieved

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

Get messages from a specific conversation. 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

Path parameters

conversation_idstringRequired

The unique id for the conversation.

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.

is_readenumOptional

Whether a conversation message has been marked as read.

Allowed values:

before_timestampdatetimeOptional

Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_timestampdatetimeOptional

Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

conversation_idstringOptional

A string that identifies this conversation.

conversation_messageslist of objectsOptional

An array of objects, each representing a conversation messages resources.

total_itemsintegerOptionalRead-only

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