Conversations

List conversations

Lists the conversations of your organization, newest first when sorted by lastEditTime. Requires the conversations:read scope.

get/api/conversations

Request

  • Base URL: https://api.supovia.com
  • URL: https://api.supovia.com/api/conversations
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

websiteIdstring
customerIdstring
limitinteger
skipinteger
sortFieldstring
Example:lastEditTime
sortDirection'ASC' | 'DESC'
resolvedboolean
spamboolean

Only conversations filed as spam (true) or only the others (false)

inboxFilter'all' | 'unread' | 'unresolved' | 'resolved' | 'mentions' | 'spam'

Operator-only bounded inbox with full filter counts; requires websiteId

conversationFilter'all' | 'last-hour' | 'today' | 'last-week' | 'online'

Time or presence scope for inboxFilter mode

timezonestring

IANA timezone for the Today inbox filter (defaults to UTC)

fieldsstring

Comma-separated projection of fields to return

Response

Array of conversations, or { conversations, total, filteredTotal } when inboxFilter is supplied

Changes

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