API keys

Create the least-privileged team API key, save its secret once, and revoke it when it is no longer needed.
2 min read · Reviewed

Use an API key only when an approved script, integration, or client needs programmatic access to your Bidlo team.

Create a key

You need the appropriate team-management access to create or remove keys.

  1. Open Settings → API.
  2. Select New key.
  3. Enter a label that identifies the owner and purpose, such as `Estimating export - production`.
  4. At Access, choose Read only unless the integration must change data.
  5. Select Create key.
  6. Copy the secret immediately and store it in an approved secret manager.

The secret is shown for you to save at creation time. Do not assume you can recover the same value later.

Use the least access required

  • Choose Read only for search, reporting, and retrieval.
  • Choose read/write access only when the integration has a reviewed need to create or change Bidlo data.
  • Create separate keys for separate tools or environments so one can be revoked without disrupting the others.

Check and revoke a key

Return to Settings → API to review a key's label and usage information.

Remove a key when the tool is retired, the owner changes, or the secret may have been exposed. Then verify that the integration can no longer connect.

FAQs

Should I create one API key for several integrations?

Use a separate key for each approved integration. That makes access easier to audit and revoke without interrupting other tools.

When does an integration need read/write access?

Only when its reviewed workflow must create or change Bidlo data. Use Read only for search, reporting, and retrieval.