get
/users/me/unread-summaryConversation unread state
Returns the number of accessible conversations with unread activity for the authenticated user across all owners and statuses, and access-scoped unread flags for requested conversations.
Authorization
Scheme
- bearerAuth
Required scopes
- user:read_self
Allowed roles
- owner
- admin
- agent
Read the caller's unread conversation summary.
Parameters
- Name
skipTotal- Type
- query boolean
- Description
- Return requested flags only. When true, unread_conversations is zero and must be ignored. Defaults to false. Separate calls have independent snapshots; flags and a previously fetched total may differ.
- Name
conversationIds- Type
- query array<string>
- Description
- Optional parameter.
Responses
- 200
Unread summary
- application/json UnreadSummaryResponse
- default
Error
- application/json ProblemDetails