For the complete documentation index, see llms.txt. This page is also available as Markdown.
Generate API Credentials
Audience: Administrators and Developers
Purpose: Explains how to generate and manage API credentials in the Kizen UI, including an API Key, User ID, and Business ID, required to authenticate requests to the Kizen API.
Overview
API credentials authenticate every request you make to the Kizen API. Before you can make your first API call, you need three credentials: an API Key, a Business ID, and a User ID. Kizen generates all three at the same time from the API Connections page.
Before You Begin
Generating API credentials requires the appropriate permission in your Kizen account. If you do not see the API Connections tab, contact your Kizen administrator to have the permission enabled for your role.
It is also strongly recommended that you generate credentials for a dedicated API user rather than your personal account. A dedicated API user limits the integration's access to only what it needs and makes credential management easier to audit over time. See your Kizen administrator to set this up before proceeding.
Generate Your API Credentials
1
In Kizen, select your Profile Avatar
The profile dropdown will appear.
2
Select My Profile
You are taken to the my profile page.
3
Select the API Connections tab
You are taken to the API Keys page.
4
Create your Credentials
In the API Keys panel, select + ADD API KEY.
The API Key Created modal appears, displaying all three credentials:
API Key — the password that authenticates the request
User ID — identifies the user making the request
Business ID — scopes the request to your Kizen business account
You have now generated your API credentials! Ensure that you copy all three values and store them in a secure location such as a secrets manager or secure vault for future use.
Managing Your API Keys
Once generated, your API keys are listed in the API Keys panel on the API Connections page.
From the API Keys Panel you can:
Create more API Keys
See the date and time each key was created
View a full API Key
Delete an API Key
Your User ID and Business ID are also always visible on the API Connections page, so you can refer back to them at any time without needing to regenerate your credentials.
