Build on your company's records.

Use BizGen's documented API from your own software, with a key limited to one company and the operations it needs.

Download OpenAPI 3.1

Authentication and permissions

Create a scoped API key using the API keys guide. Send it in the Authorization header as a Bearer token. Keep it on your server; never put a real key in a public website or client bundle.

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

The key acts in its own company. Its allowed operations, the person's current permissions, record scope, enabled features and subscription all apply. A key does not bypass approval or closed-period controls.

Read the result before retrying

Check the HTTP status and returned error. A refused request may need different permissions, corrected input or an enabled module. Do not retry a write blindly after a timeout; first check whether the record was created.

This reference covers the registered integration surface, not every internal console route. Query filters and response bodies are not exhaustively specified. A missing request schema means that body is not documented here; it does not establish that arbitrary fields are accepted.

The pages below are generated from the same registry and request schemas as the console's live OpenAPI document. Check the deployed document when planning a rollout.