Get started with the Bi369 AI REST API — authentication, base URL, rate limits, and your first API call.
Was this article helpful?
The Bi369 AI REST API lets you integrate your tools, build custom workflows, and automate operations programmatically. The API is available on the Pro and Enterprise plans.
Base URL: https://api.bi369.com/v1
All requests and responses use JSON.
The API uses Bearer token authentication. Generate an API key from Settings → API Keys.
Include the key in every request:
curl https://api.bi369.com/v1/crm/leads \
-H "Authorization: Bearer YOUR_API_KEY"
Keep your API key secure. Treat it like a password. Do not expose it in client-side code or public repositories.
All API calls are automatically scoped to your workspace (tenant). You cannot access data from other tenants.
| Plan | Requests per minute | |---|---| | Pro | 600 req/min | | Enterprise | 3000 req/min |
When you exceed the rate limit you'll receive a 429 Too Many Requests response. The Retry-After header tells you how many seconds to wait.
All responses follow this structure:
{
"success": true,
"data": { ... },
"meta": {
"total": 100,
"page": 1,
"perPage": 20
}
}
Errors return:
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Lead with ID 123 not found"
}
}
GET /v1/crm/leads List leads
POST /v1/crm/leads Create a lead
GET /v1/crm/leads/:id Get a lead
PATCH /v1/crm/leads/:id Update a lead
DELETE /v1/crm/leads/:id Delete a lead
GET /v1/finance/invoices List invoices
POST /v1/finance/invoices Create invoice
PATCH /v1/finance/invoices/:id/pay Record payment
GET /v1/projects List projects
POST /v1/projects Create project
POST /v1/projects/:id/tasks Create task
Webhooks let Bi369 AI push real-time events to your server. Configure webhooks in Settings → Webhooks.
Supported events include:
lead.created, lead.updated, lead.convertedinvoice.created, invoice.paid, invoice.overdueproject.created, task.completedEach webhook payload includes the event type and the full resource object.
You can create multiple API keys with different scopes (read-only or full access). Revoke keys at any time from Settings → API Keys.