All collections›Account›Using the Bioza API
Account3 min read

Using the Bioza API

Create a read-only key, retrieve profile or analytics data, and manage access securely.

Before you start

API access requires an active Business plan on the Bioza you want to connect. Only its owner can create or revoke API keys; a teammate’s Editor role does not grant API administration.

Each key belongs to one Bioza. It can read data but cannot create, edit, delete or publish content. Up to 10 keys can be active at once.

Create and store a key

Open Tools → Team & API access. Enter a key name that identifies your integration, choose an expiration and whether to include analytics access, then select Create API key. New keys default to 30 days. Choose 1 hour, 1 day, 7, 30, 60, 90 or 180 days, 1 year (365 days), or No expiration. The lifetime starts when the key is created.

Copy the key before selecting Done or leaving the page. The full key is shown only once. Store it as a secret environment variable on your server. Do not put it in browser code, public repositories, URLs or screenshots.

  • profile:read · included when creating a key in Tools; reads the selected Bioza’s profile, cards and Spaces, including unpublished content.
  • analytics:read · enable Include analytics access to read that Bioza’s analytics.

Authenticate a request

Send the key in the Authorization header as Bearer followed by a space and the key. Requests do not use your browser session.

Use https://bioza.app as the production base URL. When testing a preview deployment, use that deployment’s base URL instead; its data and keys belong to that environment. Additional deployment protection may also apply.

curl "https://bioza.app/api/v1/profile"  -H "Authorization: Bearer $BIOZA_API_KEY"

Available endpoints

The current public API is read-only. Only GET /api/v1/profile and GET /api/v1/analytics are supported. It does not provide content creation, publishing, audience export, webhook subscriptions or billing operations. Do not call internal dashboard endpoints as a public integration.

Read profile data

GET /api/v1/profile requires profile:read and returns a JSON object with a profile property. It contains the Bioza profile and editor content, including draft Spaces and unpublished cards. Treat the response as private; do not expose it directly to public visitors.

Read analytics

GET /api/v1/analytics requires analytics:read and returns a JSON object with an insights property. It uses the all-time reporting view available to that Bioza. The current endpoint has no custom date-range or pagination parameters.

curl "https://bioza.app/api/v1/analytics"  -H "Authorization: Bearer $BIOZA_API_KEY"

Limits and errors

Each key allows up to 60 requests per minute and 10,000 requests per day across both endpoints. Cache responses where appropriate and back off before retrying a rate-limited request. Errors return JSON with an error message.

  • 200 · the request succeeded.
  • 401 · the Bearer key is missing, invalid, expired or revoked. Check the Authorization header.
  • 403 · the key lacks the required permission, or the Bioza no longer has an active Business plan.
  • 429 · a per-minute or daily request limit has been reached. Wait before retrying.

Review, revoke or replace a key

Existing keys show their name, masked prefix, permissions, creation date, expiration and last-used date. Expiration times are displayed in your device’s local timezone. Expired keys remain visible but cannot authenticate and do not count toward the 10 active-key limit. Existing keys created before expiration was introduced keep No expiration. Not used yet means no request has successfully authenticated with that key.

Use the revoke icon beside a key to end its access immediately. To rotate a key, create a replacement, update your integration and then revoke the old key. If a key is exposed, revoke it immediately. A plan downgrade blocks API access while Business is inactive; it does not automatically revoke existing keys.