List Support Desk conversations

Changed on

Customer conversations of the project, newest activity first. The same filters as the cabinet inbox. Senders on the project's "Mute emails" list never appear. Needs the Support Desk enabled and covered by the trial, a subscription or a grant (403 otherwise). Roles: Owner, Administrator, Support Manager (and project keys).

counts is the whole backlog of the desk, independent of the filters and the page.

get/support/conversations

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/support/conversations
  • Auth
    API key in header api_key

Query parameters

status'active' | 'all' | 'unread' | 'open' | 'closed'

active (default) = unread + open, all = every status, or one status.

assigneestring

me (needs a client key), none (unassigned), any (default) or a team member id (see GET /support/members).

request_type'refund_charge' | 'cancel_subscription' | 'pricing_payment' | 'access_login' | 'bug' | 'how_to' | 'data_compliance' | 'services_partnership' | 'feature_feedback' | 'spam_auto' | 'other' | 'none'

A request type, or none for conversations that are not classified.

qstring

Search. Every word (up to 6) must appear in the customer's email, the subject, the previews or any message.

fromstring date

Last message on or after this date (project time zone)

tostring date

Last message on or before this date (project time zone)

include_demoboolean

1 = include the built-in welcome conversation

order'desc' | 'asc'

Sort by last message

pageinteger
per_pageinteger

Headers

api_keystring required
X-Web2wave-Project-Idstring
Example:my-funnel

Required for client API keys (projects.project_id slug). Not needed for legacy project keys.

Response

Conversations

successboolean

Example response

{
  "conversations": [
    {
      "status_label": "Open"
    }
  ]
}

Changes