v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
instances

retrieve instance

Retrieve a single instance by its ID

get/instances/{id}

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"
    ]
  },
  "status": "success"
}