Get instance details

GET

api

instances

{id}

curl --request GET \
  --url https://api.wappfy.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "phone_number": "<string>",
  "display_name": "<string>",
  "session_name": "<string>",
  "phone_number_id": "<string>",
  "waba_id": "<string>",
  "access_token": "<string>",
  "webhook_url": "<string>",
  "profile_picture_url": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Instance ID

Response

Instance details

string

required

user_id

string

required

name

string

required

instance_type

enum<string>

required

Available options:

waha,

cloud_api

status

enum<string>

required

Available options:

created,

starting,

scan_qr,

connected,

disconnected,

failed

is_active

boolean

required

created_at

string

required

updated_at

string

required

phone_number

string

display_name

string

WhatsApp display name (pushName)

session_name

string

phone_number_id

string

waba_id

string

access_token

string

webhook_url

string

profile_picture_url

string

Delete instancePermanently deletes an instance. For WAHA instances, the session is also cleaned up on the WAHA server.

Get instance details

curl --request GET \
  --url https://api.wappfy.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "phone_number": "<string>",
  "display_name": "<string>",
  "session_name": "<string>",
  "phone_number_id": "<string>",
  "waba_id": "<string>",
  "access_token": "<string>",
  "webhook_url": "<string>",
  "profile_picture_url": "<string>"
}