/bff/api-key/scope/list

Returns a list of all available scope codes that can be assigned to an API key. Labels + descriptions honour the optional locale query param (cs/en/de/sk/pl). Use the codes when setting scopes via the /scope/set endpoint.

API KeygetBffApi-keyScopeList

Parameters

1 query

Query parameters

· 1

localestringOptional

BCP-47 locale (cs, en, de, sk, pl). Defaults to cs.

Exampleen

Response schema

1 status code documented

200SuccessList of available API key scopes.

itemsobject[]Required

Array of available scopes.

Each array item:

codestringRequired

Scope code used for assignment.

labelstringRequired

Human-readable label for the scope.

descriptionstringRequired

Description of what the scope grants access to.

Response example

application/json

{
  "items": [
    {
      "code": "example_code",
      "label": "example_label",
      "description": "example_description"
    }
  ]
}

Request example

GET /bff/api-key/scope/list

get

curl -X GET "https://api.bizkithub.com/bff/api-key/scope/list?locale=en" \
  -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