instances

list instances

Retrieve a list of your instances.

get/instances

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances
  • Auth: HTTP bearer

Query parameters

filterstring

Filter instances by ID or name

Response

A JSON array of instances

status'success' | 'error'

Example response

{
  "instances": [
    {
      "id": 1,
      "name": "My first instance",
      "owner": "mail@example.com",
      "webhook_url": "https://my.url.com/webhook/handler",
      "webhook_events": [
        "message",
        "qr"
      ],
      "call_policy": {
        "mode": "reject_with_message",
        "message": "We do not take calls. Please send a message."
      },
      "send_protection": {
        "enabled": true,
        "disableable": true
      }
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.