List client conversations (firm)

GET /api/v1/client-messages/firm/conversations

List all client conversations across the firm's businesses.

Operation ID: list_firm_conversations_api_v1_client_messages_firm_conversations_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

firm_id string

Advisory firm ID (defaults to user's first firm)

business_id string

Filter by business

status string

Filter by status

category string

Filter by category

cursor string

Pagination cursor

limit integer default: 50
include_total_count boolean default: False

Responses

200 Successful Response

items array · ConversationSummaryResponse requiredConversationSummaryResponse

List of items

15 fields
id string required
business_id string required
advisory_firm_id string required
subject string required
category ConversationCategory requiredConversationCategory
status ConversationStatus requiredConversationStatus
created_by_user_id string required
created_by_name string
business_name string
message_count integer
last_message_preview string
last_message_at string · date-time
unread_count integer
created_at string · date-time required
updated_at string · date-time required
total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object