Skip to main content
POST
/
chat
/
find
Busca chats com filtros
curl --request POST \
  --url https://api.wppfy.com/chat/find \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "operator": "AND",
  "sort": "-wa_lastMsgTimestamp",
  "limit": 50,
  "offset": 0,
  "wa_isGroup": true,
  "lead_status": "~novo",
  "wa_label": "~importante"
}
'
{
  "chats": [
    {
      "id": "<string>",
      "wa_fastid": "<string>",
      "wa_chatid": "<string>",
      "wa_archived": false,
      "wa_contactName": "",
      "wa_name": "",
      "name": "",
      "image": "",
      "imagePreview": "",
      "wa_ephemeralExpiration": 0,
      "wa_isBlocked": false,
      "wa_isGroup": false,
      "wa_isGroup_admin": false,
      "wa_isGroup_announce": false,
      "wa_isGroup_community": false,
      "wa_isGroup_member": false,
      "wa_isPinned": false,
      "wa_label": "[]",
      "wa_lastMessageTextVote": "",
      "wa_lastMessageType": "",
      "wa_lastMsgTimestamp": 0,
      "wa_lastMessageSender": "",
      "wa_muteEndTime": 0,
      "owner": "",
      "wa_unreadCount": 0,
      "phone": "",
      "wa_common_groups": "Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)",
      "lead_name": "",
      "lead_fullName": "",
      "lead_email": "",
      "lead_personalid": "",
      "lead_status": "",
      "lead_tags": "<string>",
      "lead_notes": "",
      "lead_isTicketOpen": false,
      "lead_assignedAttendant_id": "",
      "lead_kanbanOrder": 0,
      "lead_field01": "",
      "lead_field02": "",
      "lead_field03": "",
      "lead_field04": "",
      "lead_field05": "",
      "lead_field06": "",
      "lead_field07": "",
      "lead_field08": "",
      "lead_field09": "",
      "lead_field10": "",
      "lead_field11": "",
      "lead_field12": "",
      "lead_field13": "",
      "lead_field14": "",
      "lead_field15": "",
      "lead_field16": "",
      "lead_field17": "",
      "lead_field18": "",
      "lead_field19": "",
      "lead_field20": "",
      "chatbot_agentResetMemoryAt": 0,
      "chatbot_lastTrigger_id": "",
      "chatbot_lastTriggerAt": 0,
      "chatbot_disableUntil": 0,
      "created": "strftime('%Y-%m-%d %H:%M:%f', 'now')",
      "updated": "strftime('%Y-%m-%d %H:%M:%f', 'now')"
    }
  ],
  "totalChatsStats": {},
  "pagination": {
    "totalRecords": 123,
    "pageSize": 123,
    "currentPage": 123,
    "totalPages": 123
  }
}

Authorizations

token
string
header
required

Body

application/json
operator
enum<string>
default:AND

Operador lógico entre os filtros

Available options:
AND,
OR
sort
string

Campo para ordenação (+/-campo). Ex -wa_lastMsgTimestamp

limit
integer
default:2000

Limite de resultados por página

offset
integer
default:0

Offset para paginação

wa_fastid
string
wa_chatid
string
wa_archived
boolean
wa_contactName
string
wa_name
string
name
string
wa_isBlocked
boolean
wa_isGroup
boolean
wa_isGroup_admin
boolean
wa_isGroup_announce
boolean
wa_isGroup_member
boolean
wa_isPinned
boolean
wa_label
string
lead_tags
string
lead_isTicketOpen
boolean
lead_assignedAttendant_id
string
lead_status
string

Response

200 - application/json

Lista de chats encontrados

chats
object[]
totalChatsStats
object

Contadores totais de chats

pagination
object