/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

4 body

4 total

Body · 4

environmentstring | string | stringRequired

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

relatedToMemberboolean

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

descriptionstring

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

expirationDatestring

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

Request

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"
}'

Response

Newly generated API key.

{
  "apiKey": "example_apiKey"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key