BizKitHub
DocsAPI ReferenceOrganisation Structure/bff/organisation-structure/detail

/bff/organisation-structure/detail

Departments + members with department and manager

Organisation structuregetBffOrganisation-structureDetail

Parameters

No parameters required

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

Response schema

1 status code documented

200Success
departmentsobject[]Required
Each array item:
idstringRequired
namestringRequired
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
parentIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
leadMemberIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
colorstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
positionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
chatRoomIdstring | nullRequired
One of 2:
Variant 1
string

Live department channel (team chat room id).

Variant 2
null
membersobject[]Required
Each array item:
idstringRequired

Member wire id (contact external id, as /team/{id}).

userIdstring | nullRequired
One of 2:
Variant 1
string

Global user id (team chat).

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
departmentIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
managerIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "departments": [
    {
      "id": "example_id",
      "name": "example_name"
    }
  ],
  "members": [
    {
      "id": "example_id",
      "fullName": "example_fullName"
    }
  ]
}

Request example

GET /bff/organisation-structure/detail

get
curl -X GET "https://api.bizkithub.com/bff/organisation-structure/detail" \
  -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