Overview
▾
The Beezr API connects your systems to the records and files in your workspace. Every endpoint is a POST with a JSON body and an X-API-Key header.
Start here
- Create an API key in Designer → Account settings → API Integration. Keep it on your server.
- Find your module and field names. Copy the table name from the module card and System names from its Fields page.
- Make your first query. Use the v4 read paths to get records with file references.
- Create a record. Writes use v1 paths. Add an idempotency key before you retry a create or update.
- Build your integration, or brief your AI assistant with your module's names.
One base, two path versions
Every request goes to https://services.beezr.io/generic followed by the path.
| Work | Path prefix |
|---|---|
| Create, update, delete and bulk writes | /api/v1/records/ |
| Query, get and download files | /api/v4/records/ |
Older read paths exist for existing integrations. These docs use v4.
Plan for limits and failures
A key acts for the whole workspace. All keys share the workspace limits: 60 requests per minute, 2,000 per hour and 2 at the same time. A bulk call counts as one request and handles up to 100 items.
Check success in JSON responses and check failed in bulk results. A bulk call can succeed for some items and fail for others. See Limits and Errors.
Keep the rules close
Use plain Markdown, the documentation index and OpenAPI in your editor or AI assistant. Brief your AI assistant adds your module and field names, and never asks for your API key.