← Back to Documentation
API Reference
Complete reference for all REST API endpoints. All APIs require authentication via session cookie and enforce tenant isolation.
Authentication
All API requests must include a valid session cookie. The session is established during sign-in and automatically refreshed by the middleware.
Session Cookie
Cookie: session=<jwt-token>Response Format
All API responses are JSON. Success responses return data directly; error responses include a message field.
Success (200)
{
"id": "...",
"name": "Branch Name",
"status": "active"
}Error (4xx/5xx)
{
"error": "Not found",
"message": "Branch not found"
}Branches
/api/branchesGET
/api/branchesList all branchesPOST
/api/branchesCreate a new branchPATCH
/api/branches/:idUpdate branchDELETE
/api/branches/:idDelete branchObligations
/api/obligationsGET
/api/obligationsList obligations with filtersPOST
/api/obligationsCreate obligationPATCH
/api/obligations/:idUpdate obligationDELETE
/api/obligations/:idDelete obligationPOST
/api/obligations/:id/completeMark as completePOST
/api/obligations/:id/documentsUpload documentPOST
/api/obligations/importBulk importDomains
/api/domainsGET
/api/domainsList monitored domainsPOST
/api/domainsAdd domainDELETE
/api/domains/:idRemove domainPOST
/api/domains/:id/checkManual SSL checkGET
/api/domains/:id/historyCheck historyPOST
/api/domains/importBulk importNotifications
/api/notificationsGET
/api/notificationsList notificationsPOST
/api/notifications/:id/acknowledgeAcknowledgeGET
/api/notifications/statsStatisticsConnectors
/api/connectorsGET
/api/connectorsList connectorsPOST
/api/connectorsCreate connectorPATCH
/api/connectors/:idUpdate connectorDELETE
/api/connectors/:idDelete connectorPOST
/api/connectors/:id/verifyVerify connectorGET
/api/connectors/healthHealth checkSystem
/apiGET
/api/userCurrent user infoGET
/api/dashboardDashboard statsGET
/api/audit-logsActivity logsGET
/api/jurisdictionsList jurisdictionsGET
/api/healthHealth checkCommon Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Number of results (default: 20, max: 100) |
| offset | integer | Pagination offset |
| status | string | Filter by status |
| branchId | uuid | Filter by branch |
| from | date | Start date filter |
| to | date | End date filter |
Error Codes
400Bad Request
Invalid request parameters or missing required fields
401Unauthorized
Invalid or expired session
403Forbidden
Insufficient permissions for this action
404Not Found
Requested resource does not exist
409Conflict
Resource already exists or conflict in operation
429Rate Limited
Too many requests, please slow down
Rate Limiting
API endpoints are rate-limited to prevent abuse. Limits vary by endpoint:
- • General API: 100 requests per minute per user
- • Auth endpoints: 10 requests per minute per IP
- • Webhook receivers: 1000 requests per minute per tenant