Skip to content

Get a thread

GET
/v1/threads/{id}
curl --request GET \
--url https://api.inboxcnx.com/v1/threads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Returns one conversation with its participants, message count, folders and flags, to show a thread before loading its messages.

Requires the read:messages scope.

id
required
string format: uuid

The thread-v1 object. If the requested id was merged away, the survivor’s data is returned with the survivor’s id.

Media typeapplication/json
object
id
required
string format: uuid
providerThreadId
required
string | null
source
required
string
Allowed values: gmail m365 imap
subject
required
string | null
participants
required
Array<object>
object
name
required
string | null
email
required
string
messageCount
required
integer
hasAttachment
required
boolean
firstMessageAt
required
string
lastMessageAt
required
string
lastInboundAt
required
string | null
lastOutboundAt
required
string | null
labels
required
object
system
required
Array<string>
Allowed values: inbox archive drafts sent trash junk all flagged important
custom
required
Array<string>
keywords
required
object
any
required
object
key
additional properties
boolean
all
required
object
key
additional properties
boolean

Example

{
"id": "2d8f6a1c-7b3e-4c9d-a5f0-1e2b3c4d5e6f",
"providerThreadId": "18f2b1c0a9e8d7f6",
"source": "gmail",
"subject": "Invoice 2026-1042",
"participants": [
{
"name": "Acme Accounts",
"email": "accounts@example.com"
},
{
"name": null,
"email": "owner@example.com"
}
],
"messageCount": 3,
"hasAttachment": true,
"firstMessageAt": "2026-10-21T14:02:00.000Z",
"lastMessageAt": "2026-10-23T07:58:12.000Z",
"lastInboundAt": "2026-10-23T07:58:12.000Z",
"lastOutboundAt": "2026-10-22T09:15:40.000Z",
"labels": {
"system": [
"inbox",
"sent"
],
"custom": []
},
"keywords": {
"any": {
"$seen": true,
"$flagged": true
},
"all": {
"$seen": false
}
}
}

The credential lacks the read:messages scope

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

No such thread for the caller’s organization and application

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}

The query exceeded the read timeout

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
"error": {
"code": "example",
"message": "example"
}
}