Get paginated list of chats with filtering

POST

/openapi/chat/paged

const url = 'https://open-api.replyco.com/openapi/chat/paged';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '{ "page": 1, "count": 25 }'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://open-api.replyco.com/openapi/chat/paged \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "page": 1, "count": 25 }'

Returns a filtered and paginated list of live chat conversations.

Available filters:

Status (Open, Closed, etc.)
Date range
Assigned user
Customer
Search term

Sample request:

POST /chat/paged
{
  "page": 1,
  "count": 50,
  "status": "Open",
  "searchTerm": "payment issue"
}

Authorizations

Bearer

Request Body

Filter criteria for chats including pagination and search options

object

page

integer format: int32

nullable

count

integer format: int32

nullable

term

string

nullable

searchTerm

string

nullable

asc

boolean

accounts

List of account/integration IDs to filter chats by. If empty or null, chats from all accounts are included

Array<string>

nullable

assignedUsers

List of user IDs to filter chats by assigned users. If empty or null, chats assigned to all users are included

Array<string>

nullable

type

integer format: int32

Allowed values: 0 - Open 1 - Closed 2 - MyChats

sort

Field name to sort results by. If null, default sorting is applied

string

nullable

Example

{
  "page": 1,
  "count": 25
}

Responses

200

Returns the paginated chat list

application/json

object

totalRecords

integer format: int32

pageSize

integer format: int32

pagesCount

integer format: int32

currentPage

integer format: int32

data

Array<object>

nullable

object

string format: uuid

marketId

string

nullable

title

string

nullable

accountId

string format: uuid

nullable

marketplace

integer format: int32

Allowed values: 0 - PlaceholderDoNotUse 1 - Ebay 2 - Etsy 3 - Mail 4 - BigCommerce 5 - WooCommerce 6 - Magento 7 - Shopify 8 - Linnworks 10 - Gmail 11 - Telegram 12 - Widget 13 - Cdiscount 14 - Facebook 15 - Fruugo 16 - AmazonSP 17 - Instagram 18 - Wish 19 - ChannelAdvisor 20 - CustomIntegration 21 - Outlook 22 - Veeqo 23 - Aircall 24 - Katana 25 - Billbee 26 - Kaufland 27 - WhatsApp 28 - ShopLine 29 - Brightpearl 30 - TikTok 31 - Otto 32 - RestApiEbay

createdDate

string format: date-time

nullable

widgetId

string format: uuid

nullable

status

integer format: int32

Allowed values: 0 - Open 1 - Closed

summary

string

nullable

lastReceivedMessageDate

string format: date-time

nullable

customerId

string format: uuid

nullable

customerChats

Array<object>

nullable

object

string format: uuid

customerId

string format: uuid

chatId

string format: uuid

Example

{
  "totalRecords": 1,
  "pageSize": 25,
  "pagesCount": 1,
  "currentPage": 1,
  "data": [
    {
      "id": "2e7f4a96-8b1c-4d3e-a5f7-9c2b6e4d1a83",
      "title": "Sam Taylor",
      "accountId": "e9a2c5d8-4b7f-4e1a-9c3d-6f8b2a5e1d74",
      "createdDate": "2026-10-21T08:40:00Z",
      "lastReceivedMessageDate": "2026-10-21T08:42:00Z",
      "customerId": "5c8a1e3f-7d2b-4f9c-8e6a-3b1d9f5c7e24"
    }
  ]
}

400

Invalid filter parameters

401

User is not authenticated or authorized