Messages

Get message

get/messages/{messageId}

Request

  • Base URL: https://inboxapp.com/api/v2
  • URL: https://inboxapp.com/api/v2/messages/{messageId}
  • Auth: HTTP bearer

Path parameters

messageIdstring required

Query parameters

expandstring[]

Related resources to embed next to their ID field, one path per key, at most 4.

Response

OK

idstring required
threadIdstring required

A thread: a conversation between one of the team's account links and one profile.

accountLinkIdstring required

An account link: a platform account the team connected to Inboxapp, the team's side of a conversation.

platformstring required

The platform. Every team can use twitter, linkedin; a team may have others enabled.

platformIdstring nullable required

The ID the platform gives this object. Only meaningful next to its platform.

direction'inbound' | 'outbound' required

inbound was received from the other side. outbound was sent by the account link.

contentstring required

The text as Inboxapp last saw it. A deleted message keeps its content.

editedAtstring date-time nullable required

When the message was last edited. Null when it hasn't been, or when the edit time wasn't recorded. Every version is in GET /messages/{messageId}/history.

deletedAtstring date-time nullable required

Set once the message was deleted for the account link or unsent for everyone. Deleted messages stay in lists, and GET /messages/{messageId}/history has the scope.

createdAtstring date-time required

Example response

{
  "platform": "twitter",
  "sentBy": {
    "member": {
      "createdAt": "2026-09-14T10:32:00.000Z"
    }
  },
  "entities": {
    "mentions": [
      {
        "username": "jane"
      }
    ]
  },
  "attachments": [
    {
      "contentType": "image/jpeg",
      "expiresAt": "2026-09-14T10:32:00.000Z",
      "poster": {
        "expiresAt": "2026-09-14T10:32:00.000Z"
      }
    }
  ],
  "reactions": [
    {
      "author": {
        "accountLink": {
          "platform": "twitter",
          "username": "jane",
          "pauseReasons": [
            "billing"
          ],
          "syncedAt": "2026-09-14T10:32:00.000Z",
          "createdAt": "2026-09-14T10:32:00.000Z"
        }
      },
      "createdAt": "2026-09-14T10:32:00.000Z"
    }
  ],
  "editedAt": "2026-09-14T10:32:00.000Z",
  "deletedAt": "2026-09-14T10:32:00.000Z",
  "createdAt": "2026-09-14T10:32:00.000Z",
  "thread": {
    "platform": "twitter",
    "lastMessage": {
      "createdAt": "2026-09-14T10:32:00.000Z"
    },
    "activity": {
      "at": "2026-09-14T10:32:00.000Z"
    },
    "createdAt": "2026-09-14T10:32:00.000Z",
    "accountLink": {
      "platform": "twitter",
      "username": "jane",
      "pauseReasons": [
        "billing"
      ],
      "syncedAt": "2026-09-14T10:32:00.000Z",
      "createdAt": "2026-09-14T10:32:00.000Z"
    },
    "profile": {
      "platform": "twitter",
      "username": "jane",
      "handle": "@jane",
      "platformCreatedAt": "2026-09-14T10:32:00.000Z",
      "updatedAt": "2026-09-14T10:32:00.000Z",
      "relationships": [
        {
          "connectionRequest": {
            "sentAt": "2026-09-14T10:32:00.000Z"
          }
        }
      ]
    },
    "contact": {
      "profiles": [
        {
          "platform": "twitter",
          "username": "jane",
          "handle": "@jane",
          "platformCreatedAt": "2026-09-14T10:32:00.000Z",
          "updatedAt": "2026-09-14T10:32:00.000Z",
          "relationships": [
            {
              "connectionRequest": {
                "sentAt": "2026-09-14T10:32:00.000Z"
              }
            }
          ]
        }
      ],
      "createdAt": "2026-09-14T10:32:00.000Z",
      "updatedAt": "2026-09-14T10:32:00.000Z",
      "status": {
        "color": "#3b82f6",
        "createdAt": "2026-09-14T10:32:00.000Z"
      },
      "tags": [
        {
          "color": "#3b82f6"
        }
      ],
      "assignee": {
        "createdAt": "2026-09-14T10:32:00.000Z"
      }
    },
    "assignee": {
      "createdAt": "2026-09-14T10:32:00.000Z"
    }
  },
  "accountLink": {
    "platform": "twitter",
    "username": "jane",
    "pauseReasons": [
      "billing"
    ],
    "syncedAt": "2026-09-14T10:32:00.000Z",
    "createdAt": "2026-09-14T10:32:00.000Z"
  }
}

Changes

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