Conversations

Read conversation history for your account via Customer API v2.

Base URL: https://api.ept.ai/customer-api/v2

List conversations

GET /conversation?page=1&resultsPerPage=25 HTTP/1.1
Host: api.ept.ai
Authorization: Bearer ept_prod_YOUR_KEY_ID_YOUR_SECRET
Accept: application/json

Pagination

Parameter	Type	Description
page	integer	Page number (default: 1)
resultsPerPage	integer	Page size, 1–100 (default: 15)
pageSize	integer	Alias for resultsPerPage

Sorting

Use either pair of parameter names:

Parameter	Type	Description
order_by	string	Field to sort by
sort	string	ASC or DESC (default: DESC on created_at)
sortBy	string	Alias for order_by
sortOrder	string	Alias for sort

Supported order_by / sortBy values:

Field	Description
conversation_id	Conversation UUID
id	Alias for conversation_id
channel_id	Channel ID
created_at	Created timestamp
updated_at	Updated timestamp
response_count	Number of responses in the conversation

Example:

GET /conversation?order_by=updated_at&sort=ASC HTTP/1.1

Filters

Parameter	Type	Description
channel_id	integer	Filter by channel ID
query	string	Text search across conversation fields

Response format

By default, list responses use a paginated JSON shape with count, next, previous, and results.

Set format=gridjs to receive the same paginated structure with cell values formatted for table UIs (dates as strings, nested objects JSON-encoded, and so on):

GET /conversation?format=gridjs&page=1&resultsPerPage=25 HTTP/1.1

Example response

{
  "count": 4105,
  "next": "/customer-api/v2/conversation?page=2&resultsPerPage=25&format=gridjs",
  "previous": null,
  "results": [
    {
      "conversation_id": "f384b527-3b46-4b6a-8bf1-16b44ec0502d",
      "id": "f384b527-3b46-4b6a-8bf1-16b44ec0502d",
      "title": "Example conversation",
      "status": "Open",
      "response_count": 3,
      "channel_id": 29322,
      "channel_name": "Support",
      "account_id": 426,
      "created_at": "2025-06-01 10:00:00",
      "updated_at": "2025-06-01 12:00:00"
    }
  ]
}

Get conversation

GET /conversation/{conversation_id} HTTP/1.1
Host: api.ept.ai
Authorization: Bearer ept_prod_YOUR_KEY_ID_YOUR_SECRET
Accept: application/json

Returns the conversation and its messages. Returns 404 if {conversation_id} is not found.