DocsAPI ReferenceOrganisation/bff/organisation/profile
getOrganisationAdmin BFF

/bff/organisation/profile

Returns the complete organisation profile including basic info, company details, feature flags, timezone, locale, tariff limits, branding, email configuration, order settings, post digest settings, and payment settings. Combines data from the organisation table and configuration key-value store. Sensitive values (SMTP passwords, payment gateway secrets) are NOT included — use the /settings/env-variable-value endpoint to access those individually.

OrganisationgetBffOrganisationProfile

No parameters

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

Request

GET /bff/organisation/profile

get
curl -X GET "https://api.bizkithub.com/bff/organisation/profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "name": "example_name",
  "slug": "example_slug",
  "storageSlug": "example_storageSlug",
  "vatPayer": false,
  "disableExperiments": false,
  "timezone": {
    "id": 0,
    "timezone": "Europe/Prague",
    "gmt": "+01:00",
    "label": "Central European Time - Prague"
  },
  "primaryLocale": {
    "id": 0,
    "locale": "cs"
  },
  "defaultCurrency": "CZK",
  "tariff": {
    "id": 0,
    "code": "business",
    "storageMb": 0,
    "limitMembers": 0,
    "limitProducts": 0,
    "limitOrdersMonthly": 0,
    "limitCustomers": 0,
    "limitEmailsMonthly": 0,
    "limitAiTokensMonthly": 0,
    "limitForms": 0
  },
  "orderNewInternalNotificationEnabled": false,
  "logReportDisabled": false,
  "postDigestEnabled": false,
  "paymentRecurringEnabled": false,
  "storageUsed": 0,
  "insertedDate": "example_insertedDate"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key