Get live user presence counts by workspace

Returns per-workspace online, available, and away counts based on agent presence heartbeats received in the last two minutes. SaaS owner only.

GET

https://api.channelautomation.com/api/admin/workspace-presence

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Returns

200

Live presence counts grouped by workspace

401

Authentication required

JSON

error
optional
string
success
optional
boolean

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Get live user presence counts by workspace

curl --request GET \
  --url https://api.channelautomation.com/api/admin/workspace-presence \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/admin/workspace-presence';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/admin/workspace-presence"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "error": "Authentication required",
  "success": false
}

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}