Skip to main content
GET
/
account
/
instances
List all instances
curl --request GET \
  --url https://api.wsapi.chat/account/instances \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "useCustomDefaults": true,
      "status": "<string>",
      "deviceId": "<string>",
      "expiredAt": "2023-11-07T05:31:56Z",
      "trialEndsAt": "2023-11-07T05:31:56Z",
      "isInTrial": true,
      "hasApiKey": true
    }
  ],
  "totalCount": 123,
  "pageNumber": 123,
  "pageSize": 123
}

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.

Query Parameters

​
pageNumber
integer
default:1
​
pageSize
integer
default:20
​
createdFrom
string<date-time>
​
createdTo
string<date-time>
​
status
string

Response

Paginated list of instances

​
items
object[]
​
totalCount
integer
​
pageNumber
integer
​
pageSize
integer