List Messaging Conversations

GET /tenants/{tenant}/messaging/conversations

Returns the practice's conversations in one view, newest activity first (offset and limit; the order is fixed; limit=0 returns the count alone). view=ToSort: matched to no contact and no client and not dismissed; All (the default): every conversation not dismissed; Dismissed: the dismissed ones. unread=true keeps only the unread ones (the nav badge is unread=true&limit=0). Each has its message count, newest message and unread flag, and an ambiguous unmatched one lists the contacts and clients holding its number. A user who can see only some clients gets All only, holding the conversations on those clients (directly or through the contact); ToSort and Dismissed are a 403 for them.

Requires: ViewAll on Messaging.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

unread query boolean
view query enum

ToSort All Dismissed

ToSort All Dismissed

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden