GET
/
v1
/
messages
List messages
curl --request GET \
  --url https://api.distranmail.com/v1/messages \
  --header 'Authorization: Bearer <token>'
{
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "direction": "MESSAGE_DIRECTION_UNSPECIFIED",
      "status": "MESSAGE_STATUS_UNSPECIFIED",
      "subject": "<string>",
      "sender": {
        "contact_id": "<string>",
        "contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>",
          "display_name": "<string>",
          "company": "<string>",
          "title": "<string>",
          "emails": [
            {
              "id": "<string>",
              "type": "EMAIL_TYPE_UNSPECIFIED",
              "email": "<string>"
            }
          ],
          "phones": [
            {
              "id": "<string>",
              "type": "PHONE_TYPE_UNSPECIFIED",
              "phone": "<string>"
            }
          ],
          "social_profiles": [
            {
              "id": "<string>",
              "type": "SOCIAL_PROFILE_TYPE_UNSPECIFIED",
              "username": "<string>"
            }
          ],
          "tags": [
            "<string>"
          ],
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "last_contacted_at": "2023-11-07T05:31:56Z"
        },
        "raw_address": "<string>"
      },
      "recipients": [
        {
          "contact_id": "<string>",
          "raw_address": "<string>",
          "type": "RECIPIENT_TYPE_UNSPECIFIED"
        }
      ],
      "content_blocks": [
        {
          "type": "CONTENT_TYPE_UNSPECIFIED",
          "content": "<string>",
          "sequence": 2,
          "mime_type": "application/pdf",
          "filename": "<string>",
          "size": 123,
          "metadata": {}
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "received_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

thread_id
string<uuid>
required

ID of the thread to fetch messages from

message_ids
string<uuid>[]

Optional list of specific message IDs to retrieve

page_size
integer
default:20

Number of messages to return per page

Required range: 1 <= x <= 100
page_token
string

Token for pagination

Response

200
application/json

List of messages retrieved successfully

The response is of type object.