BizKitHub
DocsAPI ReferenceApi Key/bff/api-key/list
getApi KeyAdmin BFF

/bff/api-key/list

Returns a list of all API keys for the organisation. Each key includes basic information, masked key value, environment, description, and expiration date. Active and deleted keys are both included - use the isDeleted flag to filter.

API KeygetBffApi-keyList

Parameters

No parameters required

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

Response schema

1 status code documented

200SuccessList of API keys with metadata.
itemsobject[]Required

Array of API keys.

Each array item:

Single API key item.

idstringRequired

External identifier (UUID) of the API key.

apiKeystringRequired

Masked API key value (shows first 10 chars, rest masked).

environment"PROD" | "DEV" | "ROOT"Required

Environment type: "PROD" for production, "DEV" for development/sandbox, "ROOT" for system-level access.

usedCountTodaynumberRequired

Number of API calls made with this key today.

memberobjectOptional

Member information if key is member-specific.

namestringRequired

Name of the member this key is assigned to.

isActivebooleanRequired

Whether the key is currently active and can be used.

isDeletedbooleanRequired

Whether the key has been deleted (invalidated).

descriptionstringOptional

Human-readable description of the key purpose.

expirationDateDate | string | string | numberRequired

Date when the key will expire and become unusable.

One of 4:
Variant 1
Date

Date when the key will expire and become unusable.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
insertedDateDate | string | string | numberRequired

Date when the key was created.

One of 4:
Variant 1
Date

Date when the key was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of API keys.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "apiKey": "example_apiKey",
      "usedCountToday": 0,
      "member": {
        "name": "example_name"
      },
      "isActive": false,
      "isDeleted": false,
      "description": "example_description"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/api-key/list

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