Skip to main content
POST
Fetch collections

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
number
string

Business phone number whose collections to fetch; defaults to the instance's own number.

Example:

"5511999999999"

limit
number

Maximum number of collections to return.

Example:

20

Response

Success — provider-native response body.

Product collections fetched from a WhatsApp Business account.

wuid
string
required

Resolved WhatsApp JID of the queried business number.

numberExists
boolean
required

Whether the queried number exists on WhatsApp.

isBusiness
boolean
required

Whether the number is a WhatsApp Business account.

collectionsLength
integer
required

Number of collections returned in the collections array.

collections
object[]
required

List of catalog collections.

name
string | null

Display name associated with the queried number, if available.