BizKitHub
DocsAPI ReferenceAdmin/bff/admin/organisation-white-label
getpostAdminAdmin BFF

/bff/admin/organisation-white-label

Licence row (key, active flag, expiry, note) and the organisations currently managed by this org. Requires internal admin membership.

AdmingetBffAdminOrganisation-white-label

Parameters

1 query

Query parameters

· 1
slugstringRequired

Organisation slug to look up.

Example7-napadu-s-r-o

Response schema

1 status code documented

200Success
isActivebooleanRequired

Licence is active and not expired — the org can act as an integration partner.

licenceobject | nullRequired
One of 2:
Variant 1
licenceKeystringRequired

16-char licence key.

activebooleanRequired

Raw active flag of the licence row.

validTostring | nullRequired

Expiry (ISO) or null = no expiry.

One of 2:
Variant 1
string
Variant 2
null
notestring | nullRequired

Admin note.

One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired

When the licence row was created (ISO).

Variant 2
null
managedOrganisationsobject[]Required

Non-deleted organisations whose parent_id points at this org.

Each array item:
slugstringRequired
namestringRequired
emojistring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "isActive": false,
  "managedOrganisations": [
    {
      "slug": "example_slug",
      "name": "example_name"
    }
  ]
}

Request example

GET /bff/admin/organisation-white-label

get
curl -X GET "https://api.bizkithub.com/bff/admin/organisation-white-label?slug=7-napadu-s-r-o" \
  -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