Skip to main content
GET
/
conversations
/
list
List Conversations
curl --request GET \
  --url https://api.getoutbox.ai/conversations/list \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "last_message": "<string>",
      "unread_count": 123,
      "last_activity": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Company API Key

Query Parameters

page
integer
default:1

Page number for pagination. Page size is 10 items.

Search term to filter conversations by contact name (case-insensitive)

unread_only
enum<string>
default:false

If 'true', only return conversations with unread messages or unopened calls

Available options:
true,
false

Response

List of conversations retrieved successfully

results
object[]
total
integer

Total count of conversations