API Reference

The Orvixo REST API lets you query data, manage dashboards, and generate embed tokens from your own applications.

Base URL: https://api.orvixo.com
Auth: Bearer token
Format: JSON

Authentication

All API requests require an API key passed as a Bearer token in the Authorization header. You can generate an API key from your organisation settings at Settings → API Keys.

bash
curl https://api.orvixo.com/v1/dashboards \
  -H "Authorization: Bearer orv_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"
Keep your API key secret. Do not commit it to source control. Use environment variables or a secrets manager. If a key is compromised, rotate it immediately from your organisation settings.

Rate limits

Rate limits are applied per API key. Limits vary by plan:

PlanRequests / minuteQuery rows / response
Standard12010,000
Forever30025,000
EnterpriseCustomCustom

Endpoints

Error codes

400Bad RequestMissing or invalid parameters. Check the request body and query params.
401UnauthorizedMissing or invalid API key.
403ForbiddenThe API key does not have permission to perform this action.
404Not FoundThe resource does not exist or belongs to a different organisation.
429Too Many RequestsRate limit exceeded. The Retry-After header indicates when to retry.
500Internal Server ErrorSomething went wrong on our end. Contact support if the issue persists.