BizKitHub
DocsAPI ReferenceMember/bff/member/profile-overview
getMemberAdmin BFF

/bff/member/profile-overview

Public profile (headline, bio, location, working hours, skills), away period, timezone and the organisation neighbourhood (department path + lead, manager chain, direct reports, peers, led departments).

MembergetBffMemberProfile-overview

Parameters

1 query

Query parameters

· 1
idstringRequired

Member wire id (shop__contact.external_id).

Length: 0–32
Exampleexample_id

Response schema

1 status code documented

200Success
idstringRequired
userIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isSelfbooleanRequired
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
timezonestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentPathobject[]Required
Each array item:
idstringRequired
namestringRequired
colorstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
leadMemberIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
chatRoomIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentLeadobject | nullRequired
One of 2:
Variant 1
idstringRequired
userIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fullNamestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
avatarUrlstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
managerChainobject[]Required
Each array item:
idstringRequired
userIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fullNamestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
avatarUrlstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
directReportsobject[]Required
Each array item:
idstringRequired
userIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fullNamestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
avatarUrlstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
totalReportCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
peersobject[]Required
Each array item:
idstringRequired
userIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fullNamestringRequired
jobTitlestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
avatarUrlstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
departmentNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
peerCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
ledDepartmentsobject[]Required
Each array item:
idstringRequired
namestringRequired
colorstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
leadMemberIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
chatRoomIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "id": "example_id",
  "isSelf": false,
  "skills": [
    "string"
  ],
  "departmentPath": [
    {
      "id": "example_id",
      "name": "example_name"
    }
  ],
  "managerChain": [
    {
      "id": "example_id",
      "fullName": "example_fullName"
    }
  ],
  "directReports": [
    {
      "id": "example_id",
      "fullName": "example_fullName"
    }
  ],
  "peers": [
    {
      "id": "example_id",
      "fullName": "example_fullName"
    }
  ],
  "ledDepartments": [
    {
      "id": "example_id",
      "name": "example_name"
    }
  ]
}

Request example

GET /bff/member/profile-overview

get
curl -X GET "https://api.bizkithub.com/bff/member/profile-overview?id=example_id" \
  -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