Skip to main content
GET
Get instance details

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Instance ID

Response

Instance details

id
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