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

/bff/api-key/detail

Returns detailed information about a specific API key including usage statistics. Shows the masked key value, total usage count, total API calls made, and daily usage history for the last 90 days. Useful for monitoring API key usage and identifying patterns.

API KeygetBffApi-keyDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

External identifier (UUID) of the API key.

Example550e8400-e29b-41d4-a716-446655440000

Response schema

1 status code documented

200SuccessComplete API key detail with metadata, ownership information, and usage statistics. Includes all information about the key including when it was created, when it expires, who owns it, and detailed usage history.
externalIdstringRequired

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, ROOT for system-level access.

descriptionstring | nullRequired

Human-readable description of the key purpose. Null if not set.

One of 2:
Variant 1
string
Variant 2
null
isActivebooleanRequired

Whether the key is currently active and can be used for API requests.

isDeletedbooleanRequired

Whether the key has been deleted/invalidated. Deleted keys cannot be used.

insertedDateDate | string | string | numberRequired

Date and time when the API key was created.

One of 4:
Variant 1
Date

Date and time when the API key was created.

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

Date and time when the key will expire and become unusable.

One of 4:
Variant 1
Date

Date and time when the key will expire and become unusable.

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

Member information if key is member-specific. Undefined for organisation-wide keys.

idnumberRequired

Internal member ID.

namestringRequired

Full name of the member this key is assigned to.

usedCountTodaynumberRequired

Number of API calls made with this key today.

usedCountTotalnumberRequired

Total number of days this key has been used (including today).

usedSumTotalnumberRequired

Total number of API calls made with this key (all time).

usageListobject[]Required

Daily usage history for the last 90 days, ordered by date (newest first). Can be used to generate usage charts.

Each array item:

Daily usage record.

dateDate | string | string | numberRequired

Date of usage.

One of 4:
Variant 1
Date

Date of usage.

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

Number of API calls made on this date.

scopesstring[]Required

List of scope codes assigned to this key. Empty array means full access (no restrictions).

Response example

application/json
{
  "externalId": "example_externalId",
  "apiKey": "example_apiKey",
  "isActive": false,
  "isDeleted": false,
  "member": {
    "id": 0,
    "name": "example_name"
  },
  "usedCountToday": 0,
  "usedCountTotal": 0,
  "usedSumTotal": 0,
  "usageList": [
    {
      "count": 0
    }
  ],
  "scopes": [
    "string"
  ]
}

Request example

GET /bff/api-key/detail

get
curl -X GET "https://api.bizkithub.com/bff/api-key/detail?id=550e8400-e29b-41d4-a716-446655440000" \
  -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