Skip to main content
POST
Find chats

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
where
object

Filter with any of _id, id, pushName, remoteJid.

Example:

Response

Success — provider-native response body.

remoteJid
string
required

Chat JID.

windowActive
boolean
required

Whether the 24h messaging window is currently open.

unreadCount
integer
required

Number of unread messages in the chat.

isSaved
boolean
required

Whether a contact record exists for this chat.

id
string | null

Contact record id, or null when no contact is stored.

pushName
string | null

Chat/contact/group display name.

profilePicUrl
string | null

Profile picture URL.

updatedAt
string | null

ISO timestamp of last activity.

windowStart
string | null

ISO timestamp when the 24h window started.

windowExpires
string | null

ISO timestamp when the 24h window expires.

lastMessage
object | null

Trimmed last message of the chat (media bodies cleaned).