RouxFin API Reference

Authentication

Tenant endpoints under /v1/* require an X-API-Key header. Obtain an API key from the RouxFin workspace settings or ask your administrator.

Admin endpoints under /admin/* require an X-Superadmin-Key header. Never expose either key in browser code or source repositories.

Endpoint directory

Browse the endpoint summaries below, or use the interactive reference to inspect parameters, request bodies, responses, and schemas.

• GET /healthz — Health check
• POST /v1/org/register — Create a new organisation
• GET /v1/org/retention — Get retention settings
• PATCH /v1/org/retention — Update retention settings
• POST /v1/org/accept-invite — Accept a member invitation
• POST /v1/kacaroo/message — Continue a Kacaroo coaching session
• POST /v1/kacaroo/send — Send an approved letter after Kacaroo confirmation
• POST /v1/letters/generate — Generate a letter
• POST /v1/letters/batch — Batch generate letters (async)
• GET /v1/letters/batch/{batchJobId} — Get batch job status
• GET /v1/letters — List letters
• GET /v1/letters/{letterId} — Get a letter
• POST /v1/letters/{letterId}/submit — Submit for approval
• POST /v1/letters/{letterId}/approve — Approve a letter
• POST /v1/letters/{letterId}/reject — Reject a letter
• POST /v1/letters/{letterId}/review-response — Respond to a caller review
• POST /v1/letters/{letterId}/send-email — Send letter via email
• POST /v1/letters/{letterId}/retry-pdf — Retry PDF generation
• POST /v1/letters/{letterId}/signatories — Add signatories to a contract letter
• GET /v1/letters/{letterId}/signatories — Get signatories for a letter
• GET /v1/templates — List templates
• POST /v1/templates — Create a template
• PUT /v1/templates/{templateId} — Update a template
• DELETE /v1/templates/{templateId} — Delete a template
• GET /v1/tenant/me — Get current tenant
• POST /v1/license/activate — Activate a license key
• GET /v1/billing/plans — List billing plans
• POST /v1/billing/checkout — Create checkout session
• POST /v1/billing/portal — Get billing portal URL
• GET /v1/billing/usage — Get billing usage
• GET /v1/billing/subscription — Get subscription details
• GET /v1/dashboard/stats — Get dashboard statistics
• GET /v1/webhooks/config — Get webhook configuration
• PUT /v1/webhooks/config — Set webhook configuration
• GET /v1/webhooks/deliveries — List webhook delivery history
• POST /v1/webhooks/deliveries/{deliveryId}/retry — Retry a failed webhook delivery
• GET /admin/tenants — List all tenants
• POST /admin/tenants — Create a tenant
• GET /admin/tenants/{tenantId}/stats — Get tenant stats
• GET /admin/tenants/{tenantId}/cost-by-model — Get per-model cost breakdown for a tenant
• GET /admin/tenants/{tenantId}/keys — List API keys for a tenant
• POST /admin/tenants/{tenantId}/keys — Create API key for a tenant
• DELETE /admin/tenants/{tenantId}/keys/{keyId} — Revoke an API key
• GET /v1/document-categories — List active document categories
• GET /admin/document-categories — List all document categories (admin)
• POST /admin/document-categories — Create a document category
• GET /admin/document-categories/{id} — Get a document category (admin)
• PUT /admin/document-categories/{id} — Update a document category
• DELETE /admin/document-categories/{id} — Delete a document category
• GET /admin/document-categories/{id}/preview-prompt — Preview effective system prompt for a category
• GET /admin/license-keys — List all license keys
• POST /admin/license-keys — Generate a new license key
• POST /admin/letters/batch — Cross-tenant batch letter generation
• DELETE /admin/license-keys/{keyId} — Revoke a license key

API resources

• Download the raw OpenAPI specification
• Open the interactive API reference