GET
/
wa
/
instances
curl --request GET \
  --url https://api.zapsterapi.com/v1/wa/instances \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "instances": [
    {
      "created_at": "2024-10-03T21:56:22.620Z",
      "id": "xy9rexnkwobmgg3tehgvs",
      "metadata": {
        "customer_id": "123456",
        "customer_name": "Joãozinho",
        "phone_number": "+5587989075555"
      },
      "name": "MyNewInstance2",
      "owner": {
        "display_name": null,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "qrcode": null,
      "settings": {
        "call_rejection": "all",
        "delay_per_word": true,
        "delete_chat_after_sent": true,
        "message_delay": {
          "enabled": true,
          "max": 10,
          "min": 1
        },
        "presence_behavior": "only_composing",
        "read_confirmation": "never"
      },
      "status": "disconnected",
      "webhooks": [
        {
          "enabled": true,
          "events": [
            "message.received"
          ],
          "id": "2nenz69l0xbf0m3uu9tfo",
          "name": "Webhook Name",
          "test_mode": false,
          "test_url": null,
          "url": "https://webhook.mydomain.com"
        }
      ],
      "lookup_key": "ins_8j7wlxmpjlixx9mux5"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
lookup_key
string

Filtrar por identificador de pesquisa

​
page
number
default:1

Para registros páginados, define qual página quer buscar.

​
per_page
number
default:20

Limita o número de registros por página.

​
status
enum<string>

Filtrar por status

Available options:
disconnected,
connected,
offline

Response

200 - application/json

Success

The response is of type object.