SupportWire API
API ReferenceConversations

List conversations

Required scope: `conversations:read`. Cursor-paginated.

GET
/api/oauth/v1/conversations

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth access token, e.g. Authorization: Bearer swot_….

In: header

Query Parameters

limit?integer

Items per page.

after?string

Cursor for the next page.

before?string

Cursor for the previous page.

statuses[]?array<string>

Filter by status.

assignee_id?string
email_domain?string
read_status?string
group_id?string

Response Body

application/json

curl -X GET "https://example.com/api/oauth/v1/conversations"
{
  "data": [
    {
      "id": "string",
      "inserted_at": 0,
      "initial_message": "string",
      "is_spam": true,
      "last_message": "string",
      "last_message_inserted_at": 0,
      "status": "string",
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "instagram_handle": "string",
        "profile_picture_url": "string"
      },
      "pinned": true,
      "unread_count": 0,
      "summary": "string",
      "meta_info": {},
      "guest_submission": true,
      "group_id": "string",
      "group": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "color": "string"
      },
      "conversation_assignee": {
        "id": "string",
        "conversation_id": "string",
        "user_id": "string",
        "assignor_id": "string",
        "assigned_at": 0
      }
    }
  ],
  "page_metadata": {
    "after": "string",
    "before": "string"
  },
  "unread_count_by_conversation_id": {
    "property1": 0,
    "property2": 0
  }
}