Skip to main content
GET
Get messages

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Query Parameters

sourceId
string

Optional source ID.

leadId
string

Optional lead ID.

start
string<date-time>

Optional start date.

end
string<date-time>

Optional end date.

maxCount
integer<int32>

Optional maximum number of messages to return.

Response

OK

messageId
string | null
required

The unique ID of the message

sourceId
string | null
required

The ID of the source

leadId
string | null
required

The ID of the lead

fromBot
boolean
required

Whether the message was sent from the bot

direction
string | null
required

The direction of the message (inbound or outbound)

message
string | null
required

The content of the message

attachments
object[] | null
required

The list of attachments associated with the message

timestamp
string<date-time>
required

The timestamp when the message was sent

activities
object[] | null
required

The list of activities associated with the message

botId
string | null

The optional ID of the bot

personaId
string | null

The optional ID of the persona

channel
string | null

The optional channel of the message

turnSentiment
integer<int32> | null

Turn Sentiment: the lexicon's reading of this message's own words, an integer 0–100 (higher = more positive). Populated only on inbound lead messages. 50 means no signal; null means not yet computed.

conversationSentiment
integer<int32> | null

Conversation Sentiment: the mean of the last 10 Turn Sentiments for this lead as of this message, on the same 0–100 scale. null where not yet computed.

responderName
string | null

The display name of the human responder (external messages and notes)

responderIconUrl
string | null

The avatar URL of the human responder (external messages and notes)

aiVisible
boolean

For notes (direction "note"): whether the AI can see the note

authorAccountId
string | null

For notes (direction "note"): the account ID of the note's author. Null for notes created before authorship was tracked.