API Reference#
The Novaza Platform exposes a comprehensive REST API that gives developers programmatic access to all products — Office, Desk, Pulse, Live, and Personeo. Every action available in the user interface is also available through the API.
Base URL#
Platform-level API requests go through the Novaza Gateway:
https://api.novaza.ai/The Gateway validates the caller’s JWT and routes the request to the appropriate Novaza service. Individual products (Office, Desk, Pulse) also expose their own APIs at their product URLs (e.g., https://office.novaza.ai). Those product APIs have their own authentication — see each product’s API page for details.
API versioning follows a major-version prefix (/api/v1/) on Gateway routes. Non-breaking changes (new fields, new endpoints) are added without a version bump. Breaking changes will be announced 90 days in advance with a migration guide.
Response Format#
All responses are JSON. Successful responses return HTTP 2xx status codes. Error responses return a JSON object with code, message, and optional details fields:
{
"code": "VALIDATION_ERROR",
"message": "The field 'email' is required.",
"details": {
"field": "email",
"constraint": "required"
}
}Pagination#
List endpoints return paginated results. Pass page (1-indexed, default: 1) and per_page (default: 50, max: 200) as query parameters. Responses include a meta object with total, page, per_page, and total_pages.
Rate Limits#
Rate limits are applied per tenant and vary by plan. Current limits are TBD and may be adjusted during the beta — contact support for the limits applicable to your workspace. When the limit is exceeded, the API returns HTTP 429 with a Retry-After header.