Documentation Index
Fetch the complete documentation index at: https://developer.zapsterapi.com/llms.txt
Use this file to discover all available pages before exploring further.
zapsterapi instance list
Lista as instâncias WhatsApp disponíveis para o perfil ativo.
zapsterapi instance list \
[--status <connected|offline|disconnected>] \
[--lookup-key <chave>] \
[--page <n>] \
[--per-page <n>] \
[-q, --query <texto>] \
[--profile <nome>] \
[--json]
| Flag | Obrigatório | Descrição |
|---|
--status <status> | Não | Filtra por status: connected, offline ou disconnected. |
--lookup-key <chave> | Não | Filtra por lookup_key (chave externa que você associou à instância). |
--page <n> | Não | Página (default: 1). |
--per-page <n> | Não | Itens por página (default: 15, máx: 100). |
-q, --query <texto> | Não | Busca textual no nome da instância. |
ID NAME STATUS CONNECTION
i_01HABC... Atendimento connected unofficial
i_01HXYZ... Marketing offline unofficial
{
"ok": true,
"data": {
"instances": [
{
"id": "i_01HABC...",
"name": "Atendimento",
"status": "connected",
"connection_type": "unofficial"
}
],
"total": 1
}
}
Exemplos
# Apenas instâncias conectadas
zapsterapi instance list --status connected
# Procurar por nome
zapsterapi instance list -q "atendimento"
# Paginação
zapsterapi instance list --page 2 --per-page 50
