/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

1 total

Query · 1

idstringRequired

External identifier (UUID) of the API key.

Request

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"

Response

Complete 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.

{
  "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"
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key