Skip to main content
GET
/
public-api
/
conversations
Retrieve a paginated list of conversations
curl --request GET \
  --url https://agents.nineteen58.co.za/public-api/conversations \
  --header 'x-api-key: <api-key>'
{
  "conversations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contacts": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>"
      },
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation": {}
    }
  ],
  "totalCount": 123,
  "currentPage": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
contactId
string<uuid>

Filter conversations by contact ID

agentId
string<uuid>

Filter conversations by agent ID

identifier
string

Filter conversations by contact identifier

Response

Successfully retrieved conversations

conversations
object[]
totalCount
integer
currentPage
integer
pageSize
integer
totalPages
integer