API keys

Create a key that lets your own software use BizGen's API in one company, limited to the operations you choose.

What an API key does

An API key lets a script or another system call BizGen as one person, in one company. It can only do the operations ticked on the key, and only those the person’s role allows. If the person’s role changes, the key changes with it straight away. If they leave the company, the key stops working.

Every action made with a key appears in the audit trail, marked API key.

Who can create keys

Owners and admins. The API Keys card only shows for them. You can create a key for yourself. An owner, signed in themselves, can also create one for a member who isn’t an owner. A key can never do more than both you and that member are allowed to do.

Create a key

  1. For yourself: open your account menu (top right) and choose My profile. Scroll to API Keys. For a member: go to Settings › User management and choose Manage API keys (the key icon) next to them.
  2. Choose Create API Key.
  3. Give it a Name, such as “Stock sync”.
  4. Optionally pick an Expiry date (optional). The key works until the end of that day, Malaysia time.
  5. Under Allowed operations, tick what the key may do, such as clients.read. Select read operations ticks every read-only operation you can grant.
  6. Choose Create.
  7. Copy the key. It starts with pk_. It will not be shown again, so store it somewhere safe, then choose Done.

The list shows each key’s name, the start of the key, how many allowed operations it has, when it was created and last used, and when it expires. A key marked Legacy role-wide key has no operation limits: replace it with a new key.

Send the key

Put the key in the Authorization header of each request, after Bearer:

curl https://console.bizgen.app/api/clients?search=acme \
  -H "Authorization: Bearer pk_your_key_here"

This lists clients, so the key needs clients.read. List requests take page (from 0) and limit (up to 100).

Browse the API reference for documented resources, permissions and request schemas, or download its OpenAPI document for your integration tools.

BizGen answers:

What a key can’t do

A key works in its own company only. It can’t switch companies, change two-factor or security settings, change notification preferences, link WhatsApp, Telegram, SMS or push, open the inbox, or take part in appraisals. These need the person’s own signed-in session.

The company’s two-factor rule applies to people signing in, not to keys. Protect a key as you would a password.

Revoke a key

  1. Find the key under API Keys.
  2. Choose the bin icon, then Revoke.

Anything using the key loses access at once. This can’t be undone. An owner or admin can revoke any key in the company.