Threads

Get thread

get/threads/{threadId}

Request

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

Path parameters

threadIdstring required

Query parameters

expandstring[]

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

Response

OK

idstring required
platformstring required

Always the platform of the thread's account link and profile.

platformIdstring nullable required

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

accountLinkIdstring required

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

profileIdstring required

A profile: one person's account on one platform. Not a contact ID.

contactIdstring required

A contact: the team's record of the person, with their status, tags, notes, valuation and default assignee.

assigneeIdstring nullable required

A member: a person on the team.

isRequestboolean required

True while the conversation is an incoming request the account hasn't replied to or accepted. Requests are in the requests folder, not inbox.

acceptanceState'required' | 'notRequired' | 'unknown' required

Whether the platform needs the account to accept the conversation before replying normally. unknown when the platform doesn't say. Independent of isRequest.

archivedboolean required
unreadboolean required

Marked unread in Inboxapp for the team owner, whose view the API takes. A thread no one has opened yet is not unread.

restrictionsstring[] required

Capabilities the platform disables in this conversation, on top of the account link's capabilities. Using one fails with threadRestricted.

syncingboolean required

True while Inboxapp imports the conversation's older messages, so the message list may be incomplete.

typingIndicators'enabled' | 'disabled' | 'teamDefault' required

Whether Inboxapp sends typing indicators to the platform while someone composes in this thread. teamDefault follows the team's setting.

createdAtstring date-time required

Example response

{
  "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"
  }
}

Changes

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