BizKitHub
DocsAPI ReferencePresence/bff/presence/members
getPresenceAdmin BFF

/bff/presence/members

Lean list of active, non-blocked members of the current organisation with name, avatar and the effective availability status (manual cas__user.activity_status combined with the last heartbeat by resolveActivityInfo). Backs the shared admin presence cache used by every member avatar and by the team chat. Available to every member; no module permission required.

PresencegetBffPresenceMembers

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
userIdstringRequired

User wire id (cas__user.external_id), the team chat identity.

fullNamestringRequired
usernamestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isYoubooleanRequired
customStatusobject | nullRequired
One of 2:
Variant 1
emojistring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
textstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
clearDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
statusUntilstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
inCallbooleanRequired
workLocationstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
meetingUntilstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
avatarInfoobjectRequired
fullNamestringOptional
avatarUrlstringOptional
activityInfoobjectOptional
statusstringOptional
inActiveMinutesnumberOptional
lastActivitystring | Date | string | string | numberOptional
One of 2:
Variant 1
string
Variant 2
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "userId": "example_userId",
      "fullName": "example_fullName",
      "username": "example_username",
      "isYou": false,
      "inCall": false,
      "avatarInfo": {
        "fullName": "example_fullName",
        "avatarUrl": "example_avatarUrl",
        "activityInfo": {
          "status": "example_status",
          "inActiveMinutes": 0
        }
      }
    }
  ]
}

Request example

GET /bff/presence/members

get
curl -X GET "https://api.bizkithub.com/bff/presence/members" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key