Skip to main content
GET
/
api
/
inbox
/
conversation
List Conversations
curl --request GET \
  --url https://api.hilos.io/api/inbox/conversation \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "<string>",
      "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "CREATED",
      "first_message": {
        "id": "<string>",
        "to_number": "<string>",
        "from_number": "<string>",
        "body": "<string>",
        "direction": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "contact": "<string>",
        "status": "new",
        "queued_on": "2023-11-07T05:31:56Z",
        "accepted_on": "2023-11-07T05:31:56Z",
        "sent_on": "2023-11-07T05:31:56Z",
        "delivered_on": "2023-11-07T05:31:56Z",
        "read_on": "2023-11-07T05:31:56Z",
        "failed_on": "2023-11-07T05:31:56Z",
        "provider_id": "<string>",
        "provider_error_code": "<string>",
        "provider_error_message": "<string>",
        "sent_by": {
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "id": 123,
          "profile_image": "<string>",
          "role": "AGENT"
        },
        "is_deleted": true,
        "content": {},
        "whatsapp_template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "content_type": "<string>",
        "content_url": "<string>",
        "msg_type": "audio",
        "failed_attempts": 123,
        "source": "INBOUND"
      },
      "assigned": [
        {
          "id": 123,
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "account": 123,
          "profile_image": "<string>",
          "date_joined": "2023-11-07T05:31:56Z"
        }
      ],
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "created_on": "2023-11-07T05:31:56Z",
      "source": "INBOX",
      "assigned_team": 123,
      "channel": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
contact
string<uuid>

A Contact Id to filter the Conversations and only get those from that Contact.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

A search term.

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]