List unread messages
Returns the messages your company has not read yet, across every chat, with the chats they belong to.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Query parameters
pageintegerWhich page to return. The first page is 1.
default: 1example: 1
pageSizeintegerHow many items to return per page. Between 1 and 100.
default: 50example: 25
messageTypeenum<string>Which kind of message to count as unread.
default: participantparticipantpropertyManagerbotannouncement
Response
200 · One page of unread messages.
itemsChatMessage[]The unread messages, one page at a time.
currentPageintegerThe page number that was returned.
totalPagesintegerHow many pages exist at this page size.
pageSizeintegerHow many items a page holds.
totalCountintegerHow many items match in total, across every page.
chatsChat[]The chats the messages in items belong to, so you can show each message in context without another call.
401 · The access token is missing, expired, or not valid.
By default only messages from the other side — the tenant, owner, or vendor — are returned. Set messageType to look at your team's own messages, the AI's, or announcements instead.