Pular para o conteúdo principal
POST
/
instances
/
list
Listar instancias
curl --request POST \
  --url https://api.vzaps.com/instances/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "size": 20,
  "sort": "created_at",
  "sort_desc": true,
  "filter": {}
}
'
{
  "page": 123,
  "size": 123,
  "total": 123,
  "total_pages": 123,
  "content": [
    {
      "id": "VZ9K2M4N8P1Q3R5S7T0WABCD01EF",
      "name": "Minha instancia",
      "token": "inst_xxxxxxxxxxxxx",
      "url": "https://app.vzaps.com/instances/VZ9K2M4N8P1Q3R5S7T0WABCD01EF",
      "webhook": "https://cliente.exemplo.com/webhooks/vzaps",
      "events_subscribe": "Message,Connected,Disconnected",
      "reject_calls": false,
      "auto_read_messages": false,
      "connected": false,
      "billing_status": "TRIALING",
      "created_at": "2026-04-13T10:00:00Z",
      "updated_at": "2026-04-13T10:00:00Z"
    }
  ],
  "summary": {
    "connected_count": 123,
    "disconnected_count": 123,
    "paid_instance_count": 123,
    "paid_plan_value_total": 123
  }
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
page
integer
size
integer
filter
object
sort
string
sort_desc
boolean

Resposta

Listagem

page
integer
size
integer
total
integer
total_pages
integer
content
object[]
summary
object