Skip to main content
GET
/
threads
/
lookup
Lookup thread
curl --request GET \
  --url https://inboxapp.com/api/v1/threads/lookup \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "platform": "twitter",
  "platformId": "<string>",
  "done": true,
  "assigneeId": "df6jbw4h36...",
  "lastMessageTimestamp": "2025-08-22T12:00:00.000Z",
  "computedSortTimestamp": "2025-08-22T12:00:00.000Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "active",
  "variant": "unencrypted",
  "accountLinkId": "<string>",
  "isSyncing": true,
  "isRequest": true,
  "typingIndicatorsEnabled": true,
  "lastMessage": {
    "id": "<string>",
    "content": "<string>",
    "authorId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "userId": "df6jbw4h36...",
    "campaignId": "df6jbw4h36..."
  },
  "prospect": {
    "platform": "twitter",
    "platformId": "<string>",
    "externalId": "l44e15irdq4db30i77cgphhx",
    "documentId": 858224163,
    "displayName": "<string>",
    "username": "<string>",
    "handle": "<string>",
    "image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "imageNormalized": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "bio": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
    "location": "San Francisco, CA",
    "profileUrl": "<string>",
    "websiteUrl": "https://inboxapp.com",
    "websiteDomain": "inboxapp.com",
    "verified": "none",
    "profileType": "personal",
    "isProtected": true,
    "followerCount": 123,
    "followingCount": 123,
    "postCount": 123,
    "engagementCount": 2613,
    "listedCount": 18,
    "platformCreatedAt": "2022-09-03T17:58:06.000Z",
    "firstSeenAt": "2024-07-09T14:08:49.000Z",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "lastEnrichedAt": "2025-11-10T18:03:16.000Z",
    "lastActiveAt": "2025-11-10T12:00:00.000Z",
    "source": "cached",
    "isFresh": true,
    "isStale": true,
    "confidence": 0.5,
    "platformData": {
      "isVerifiedBlue": true,
      "isVerifiedGold": true,
      "isVerifiedGray": true,
      "professionalCategory": "986",
      "urlEntities": [
        {
          "url": "<string>",
          "expandedUrl": "<string>",
          "displayUrl": "<string>",
          "indices": [
            123,
            123
          ]
        }
      ],
      "bannerUrl": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
      "tweetsCount": 123,
      "favoritesCount": 123,
      "rawData": {}
    },
    "context": {
      "tags": [
        "<string>"
      ],
      "statusId": "df6jbw4h36...",
      "valuation": 599,
      "notes": "This prospect is a potential customer."
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
accountLinkId
string
required

The account link ID associated with the thread.

Pattern: ^[0-9a-z]+$
​
externalPlatformId
string

The platform ID of the prospect. Must be provided if externalId is not provided.

​
externalId
string

The Inbox external ID of the prospect. Must be provided if externalPlatformId is not provided.

Pattern: ^[0-9a-z]+$

Response

200 - application/json
object | null

OK

​
id
string
required

The ID of the thread.

Pattern: ^[0-9a-z]+$
Example:

"df6jbw4h36..."

​
platform
enum<string>
required

The platform this thread belongs to.

Available options:
twitter
Example:

"twitter"

​
platformId
string
required

The platform ID of the conversation.

Example:

"1234567890"

​
done
boolean
required

Whether the thread has been archived or not.

Example:

true

​
assigneeId
string | null
required

The ID of the member assigned to the thread.

Pattern: ^[0-9a-z]+$
Example:

"df6jbw4h36..."

​
lastMessageTimestamp
string<date-time> | null
required

The timestamp of the last message in the thread.

Example:

"2025-08-22T12:00:00.000Z"

​
computedSortTimestamp
string<date-time> | null
required

The timestamp of the last message in the thread or the creation date if no messages have been sent.

Example:

"2025-08-22T12:00:00.000Z"

​
createdAt
string<date-time>
required

The timestamp of when the thread was created in Inbox.

Example:

"2025-08-22T12:00:00.000Z"

​
status
enum<string>
required

Idle threads are hidden from the main inbox, i.e. when previewing a profile using 'Quick peek'

Available options:
active,
idle
Example:

"active"

​
variant
enum<string>
required

Will be set to "unencrypted" by default for new conversations until both parties have exchanged messages. Once each party has sent at least one message, the conversation transitions to "xChat" (encrypted).

Available options:
unencrypted,
xChat
Example:

"unencrypted"

​
accountLinkId
string
required

The ID of the account link associated with this thread.

Pattern: ^[0-9a-z]+$
Example:

"df6jbw4h36..."

​
isSyncing
boolean
required

Whether the thread is currently syncing data from Twitter to load all messages.

Example:

false

​
isRequest
boolean
required

Whether this conversation is a message request.

Example:

false

​
typingIndicatorsEnabled
boolean | null
required

Whether typing indicators are enabled for this thread. If set to null, will use the team default setting.

Example:

true

​
lastMessage
object
required
​
prospect
object
required