Inbox

List accessible inbox conversations with existing folder and status filters

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

get/workspaces/{workspaceId}/inbox

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required

Query parameters

status'open' | 'snoozed' | 'closed' | 'spam'
folder'mentions' | 'spam' | 'team' | 'created-by-you' | 'unseen'
teamIdstring
labelIdstring
unseen'1'

Response

List accessible inbox conversations with existing folder and status filters

idstring required
agentIdstring required
agentNamestring nullable required
channel'playground' | 'widget' | 'api' | 'email' | 'dashboard' required
subjectstring nullable required
ticketNumberinteger nullable required
mode'ai' | 'human' required
createdAtstring date-time required
lastMessageAtstring date-time required
contactIdstring nullable required
createdBystring nullable required
messageCountinteger required
previewstring nullable required
lastMessageRolestring nullable required
inboxStatus'open' | 'snoozed' | 'closed' | 'spam' required
assigneeIdstring nullable required
teamIdstring nullable required
prioritystring required
dueAtstring date-time nullable required
unseenCountinteger required
awaitingTeammateboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.