Skip to main content
GET
Find chat by JID

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.

Response

object | null

Success — provider-native response body.

The stored Chat record for the given remoteJid, or null when no chat exists.

id
string
required

Chat record id (cuid).

remoteJid
string
required

Chat JID.

instanceId
string
required

Owning instance id.

unreadMessages
integer
required

Count of unread messages in the chat.

name
string | null

Chat/group name, when known.

labels
string[] | null

Label ids applied to the chat.

createdAt
string

ISO timestamp when the chat was created.

updatedAt
string

ISO timestamp of last update.