Skip to main content
POST
Buscar coleções

Autorizações

apikey
string
header
obrigatório

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

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
number
string

Número de telefone business cujas coleções serão buscadas; por padrão, usa o próprio número da instância.

Exemplo:

"5511999999999"

limit
number

Número máximo de coleções a retornar.

Exemplo:

20

Resposta

Sucesso — corpo de resposta nativo do provedor.

Product collections fetched from a WhatsApp Business account.

wuid
string
obrigatório

Resolved WhatsApp JID of the queried business number.

numberExists
boolean
obrigatório

Whether the queried number exists on WhatsApp.

isBusiness
boolean
obrigatório

Whether the number is a WhatsApp Business account.

collectionsLength
integer
obrigatório

Number of collections returned in the collections array.

collections
object[]
obrigatório

List of catalog collections.

name
string | null

Display name associated with the queried number, if available.