Skip to main content
GET
Get Chat by Chat ID
Required token scopes: Send session message

Authorizations

Authorization
string
header
required

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

Path Parameters

chatId
string
required

The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the contact's phone number

Response

The public chat view. Field-by-field reference: The Chat object

The public chat view returned by Get Chat by ID. Note: this is a trimmed version of the chat - fields like _id, labels, crmData and displayName are not included, and botState is narrowed to its id only.

success
boolean
Example:

true

title
string
channelInfo
object

Channel that an entity belongs to

departmentId
string | null
agent
object
status
enum<integer>

Chat status: 0 = BOT (handled by bot), 1 = PENDING (waiting for an agent), 2 = ASSIGNED (shown as "Taken" in Texter), 3 = RESOLVED, 4 = BULK

Available options:
0,
1,
2,
3,
4
created
string<date-time>
updatedAt
string<date-time>
lastIncomingMessageTimestamp
number

Epoch milliseconds

lastMessage
object
blockedChat
object
unreadCount
number
unsubscribed
object
externalBot
boolean
language
string
botState
object

Narrowed bot state - only the session ID is returned

lastMessageTimestamp
number

Timestamp (epoch milliseconds) of the last message sent or received