Skip to main content
REST API

A REST API for your own integrations

Generate reports, refresh dashboards, trigger syncs and run forecasts from your own code. The API is JSON over HTTPS at https://claribi.com/api/v1/, documented with OpenAPI.

Start a 14-day trial API reference

Professional and Enterprise only.

terminal
# List your dashboards (Professional and Enterprise)
curl https://claribi.com/api/v1/dashboards/ \
  -H "Authorization: Bearer claribi_..."
01  Resources

What the API covers

ResourceOperations
ReportsList, read, create, update, delete, generate, download, create a public link
DashboardsList, read, create, update, delete, refresh, create a public link
Data sourcesList, read, start a sync
GoalsList, read, progress
ForecastsCreate, read, update, delete, run, run history, trust summary, cost estimate
AccountVerify a key, read usage
02  Keys and permissions

How access works

  • Send the key as Authorization: Bearer claribi_.... Keys are stored as hashes and shown once when created.
  • Each key carries scopes such as reports:read, reports:generate, dashboards:refresh, data_sources:read or forecasts:run, so a key can do only what it needs.
  • Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
  • Calls that generate reports or run forecasts use AI credits from your plan.
03  Rate limits

Requests per plan

PlanGeneral requestsGeneration requests
Professional1,000 per hour, 20,000 per day100 per hour, 500 per day
Enterprise5,000 per hour, 100,000 per day500 per hour, 2,000 per day
04  Example

List your dashboards

The interactive reference at /api/v1/docs/ lists every endpoint with its parameters and responses.

curl https://claribi.com/api/v1/dashboards/ \
  -H "Authorization: Bearer $CLARIBI_API_KEY"
05  Not included

What the API does not do

  • There are no outbound webhooks yet. To react to changes, poll the API.
  • Data is read through reports, dashboards and forecasts; there is no raw SQL endpoint.
  • If you want an AI assistant rather than code to talk to clariBI, the MCP server is available from the Trial up.

Build on your own data

The API is part of Professional ($199 a month) and Enterprise. You can try the rest of clariBI in the 14-day trial first.

Start a 14-day trialSee pricing