Skip to content
Reference/Chats/List Chats

List Chats

GEThttps://public.leadpattern.com/chats
application/json60 req/min

Retrieve the chat inbox — one row per contact with their last message. Supports search, status (open|closed|unread|awaiting_reply), and tagId filters.

  • assignedToMe, unassigned and archived are read as the string "true" — send ?unassigned=true, not a JSON boolean.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Query Parameters

5 fields
pagenumber
optionaldefault: 1
Page number.
limitnumber
optionaldefault: 10
Results per page.
searchstring
optional
Search by name/phone.
statusenum
optional
Filter by chat status.
Allowed values:
openclosedunreadawaiting_reply
tagIdstring
optional
Filter by tag.

Responses

JSON Response
{
  "type": "success",
  "data": [
    {
      "waId": "9195XXXXXXXX",
      "contact": {
        "name": {
          "first": "John"
        },
        "status": "open"
      },
      "lastMessage": {
        "message": {
          "body": "Hello"
        },
        "timestamp": "2026-07-01T10:30:00.000Z"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1
  }
}

Sample Request

{
  "page": 1,
  "limit": 10
}