Skip to main content
GET
/
account
/
instances
/
{id}
Get instance detail
curl --request GET \
  --url https://api.wsapi.chat/account/instances/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "name": "<string>",
  "hasApiKey": true,
  "settings": {
    "useCustomDefaults": true,
    "pullMode": true,
    "webhookUrl": "<string>",
    "eventSigningSecret": "<string>",
    "historySync": true,
    "eventFilters": [
      "<string>"
    ]
  },
  "status": "<string>",
  "deviceId": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Customer API key. Only the customer-level key is accepted for /account/* endpoints. No X-Instance-Id header is required.

Path Parameters

​
id
string
required

Response

Instance detail

​
name
string
​
hasApiKey
boolean
​
settings
object
​
status
string
​
deviceId
string | null
​
created
string<date-time>