Skip to main content
POST
Find contacts

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.

id
string
required

Contact record id (cuid).

remoteJid
string
required

Contact JID.

instanceId
string
required

Owning instance id.

isGroup
boolean
required

True when remoteJid ends with @g.us.

isSaved
boolean
required

True when the contact has a pushName or profilePicUrl.

type
string
required

Derived category: "group", "contact" or "group_member".

pushName
string | null

Display/push name.

profilePicUrl
string | null

URL of the contact profile picture.

createdAt
string

ISO timestamp when created.

updatedAt
string

ISO timestamp of last update.