BizKitHub
DocsAPI ReferenceTeam Chat/bff/team-chat/profile
getTeam ChatAdmin BFF

/bff/team-chat/profile

Visible for contacts (shared organisations or conversation partners) and the caller. Positions only for organisations both share.

Team chatgetBffTeam-chatProfile

Parameters

1 query

Query parameters

· 1
userIdstringRequired

User wire id (cas__user.external_id).

Length: 1–32
Exampleexample_userId

Response schema

1 status code documented

200Success
object | object
One of 2:
Variant 1
state"ok"Required
profileobjectRequired
idstringRequired
fullNamestringRequired
isYoubooleanRequired
avatarInfoobjectRequired
fullNamestringOptional
avatarUrlstringOptional
activityInfoanyOptional
headlinestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
biostring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
locationstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
workingHoursstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
skillsstring[]Required
awayUntilstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
awayMessagestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
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
workLocation"office" | "remote" | "travel" | nullRequired
One of 2:
Variant 1
"office" | "remote" | "travel"
Variant 2
null
meetingUntilstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
timezonestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastLocationobject | nullRequired
One of 2:
Variant 1
citystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
countrystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
seenAtstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
organisationsobject[]Required
Each array item:
memberIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
slugstringRequired
namestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
managerstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
state"not-found"Required

Response example

application/json
{
  "state": "ok",
  "profile": {
    "id": "example_id",
    "fullName": "example_fullName",
    "isYou": false,
    "avatarInfo": {
      "fullName": "example_fullName",
      "avatarUrl": "example_avatarUrl"
    },
    "skills": [
      "string"
    ],
    "organisations": [
      {
        "slug": "example_slug",
        "name": "example_name"
      }
    ]
  }
}

Request example

GET /bff/team-chat/profile

get
curl -X GET "https://api.bizkithub.com/bff/team-chat/profile?userId=example_userId" \
  -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