BizKitHub
DocsAPI ReferenceAdmin/bff/admin/manager-candidate-list
getAdminAdmin BFF

/bff/admin/manager-candidate-list

Returns every organisation currently holding an active row in cas__white_label_licence — i.e. the set of orgs the internal admin may pick from when assigning parent_id on another org (integration partner / manager relation). Excludes soft-deleted orgs. Ordered by name. managedOrgCount shows how many active orgs each candidate already manages, so the picker can display "already manages 3 orgs" alongside the name. Requires internal admin membership.

AdmingetBffAdminManager-candidate-list

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:
organisationIdnumberRequired

Internal id of the candidate organisation.

slugstringRequired

URL slug of the candidate.

namestringRequired

Display name.

emojistring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
licenceKeystringRequired

16-character licence key from cas__white_label_licence.licence_key.

licenceValidTostring | nullRequired

Licence expiry (ISO-8601). NULL means the licence has no expiry set.

One of 2:
Variant 1
string
Variant 2
null
managedOrgCountnumberRequired

How many active (non-deleted) orgs currently list this candidate as their parent. Useful in the picker to show "already manages N orgs" at a glance.

Response example

application/json
{
  "items": [
    {
      "organisationId": 0,
      "slug": "example_slug",
      "name": "example_name",
      "licenceKey": "example_licenceKey",
      "managedOrgCount": 0
    }
  ]
}

Request example

GET /bff/admin/manager-candidate-list

get
curl -X GET "https://api.bizkithub.com/bff/admin/manager-candidate-list" \
  -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