/bff/api-key/generate-key

Creates a new API key for programmatic access to the API. The key is a random 32-character string that must be included in API requests. Keys can be organisation-wide or member-specific, and are associated with an environment (production, sandbox, or test). Store the returned key securely - it cannot be retrieved later, only viewed in masked form.

API KeypostBffApi-keyGenerate-key

Parameters

JSON body

Request body

application/json

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

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

ExamplePROD

relatedToMemberbooleanOptional

Whether to associate this key with the current member. If true, key is member-specific.

descriptionstringOptional

Human-readable description of the key purpose (e.g., "Mobile app integration", "Partner API access").

ExampleMobile app integration

expirationDatestringOptional

Expiration date in ISO format (YYYY-MM-DD). If not provided, key expires in 90 days from creation.

Example2026-07-18

Response schema

1 status code documented

200SuccessNewly generated API key.

apiKeystringRequired

The generated API key (32 character string). IMPORTANT: Store this securely - it will not be shown again.

Response example

application/json

{
  "apiKey": "example_apiKey"
}

Request example

POST /bff/api-key/generate-key

post

curl -X POST "https://api.bizkithub.com/bff/api-key/generate-key" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "environment": "PROD",
  "relatedToMember": false,
  "description": "Mobile app integration",
  "expirationDate": "2026-07-18"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key