instances

retrieve instance

Retrieve a single instance by its ID

get/instances/{id}

Request

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

Path parameters

idinteger required

Instance ID

Response

JSON representation of your instance

status'success' | 'error'

Example response

{
  "instance": {
    "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.