StrataHQ API Documentation The backend API is implemented in Go with Chi. Most product endpoints are mounted under /api/v1; open integration endpoints are mounted under /api/open/v1.
The standard JSON API success envelope uses a data wrapper. Example 200 OK body:
List and paginated responses include meta only when the handler returns them through response.JSONList:
{ "data" : [], "meta" : { "page" : 1 , "per_page" : 50 , "total" : 123 } } Documented exceptions outside the standard JSON API success envelope:
Some successful endpoints return 204 No Content.
GET /api/open/v1/openapi.json serves the OpenAPI document directly instead of the standard JSON envelope.The signed-link early-access flows render HTML pages instead of the standard JSON envelope:
GET /api/v1/early-access/{id}/approvePOST /api/v1/early-access/{id}/approveGET /api/v1/early-access/{id}/rejectPOST /api/v1/early-access/{id}/reject
GET /metrics serves Prometheus text output.GET /api/v1/whatsapp/webhooks can return plain-text verification output or a bare 200 OK.POST /api/v1/whatsapp/webhooks returns a bare 200 OK on successful inbound webhook handling.
Standard JSON API error responses use this shape. Example 400 BAD_REQUEST body:
{ "error" : { "code" : " BAD_REQUEST" "message" : " Human-readable message" "requestId" : " req_123" Exceptions outside the standard JSON API error envelope:
The signed-link early-access flows return HTML error pages instead of JSON error bodies.
GET /metrics can return a plain-text 401 unauthorized response when a metrics token is configured and the request omits or mismatches it.GET /api/v1/whatsapp/webhooks can return plain-text or bare non-JSON responses during provider verification flows.
Method
Path
Auth
Purpose
GET/healthzNo
Liveness check
GET/readyzNo
Readiness check for database and Redis
GET/metricsToken when configured
Prometheus metrics
Method
Path
Auth
Purpose
POST/api/v1/auth/registerNo
Register user
POST/api/v1/auth/loginNo
Log in
POST/api/v1/auth/refreshNo
Refresh access token
POST/api/v1/auth/logoutNo
Log out and revoke refresh token
POST/api/v1/auth/forgot-passwordNo
Request password reset
POST/api/v1/auth/reset-passwordNo
Complete password reset
POST/api/v1/onboarding/setupOrg admin
Complete org and scheme onboarding
GET/api/v1/auth/meAuthenticated user
Current user profile
PATCH/api/v1/auth/profileAuthenticated user
Update user profile
PATCH/api/v1/auth/orgOrg admin
Update organization
POST/api/v1/auth/change-passwordAuthenticated user
Change password
Method
Path
Auth
Purpose
GET/api/v1/schemesAuthenticated user
List schemes visible to the user
POST/api/v1/schemesOrg admin
Create scheme
GET/api/v1/schemes/{id}Scheme member or org admin
Get scheme detail
PUT/api/v1/schemes/{id}Org admin
Update scheme
DELETE/api/v1/schemes/{id}Org admin
Delete scheme
GET/api/v1/schemes/{id}/unitsScheme member or org admin
List scheme units
POST/api/v1/schemes/{id}/unitsOrg admin
Create unit
PUT/api/v1/schemes/{id}/units/{unitId}Org admin
Update unit
GET/api/v1/schemes/{id}/membersScheme member or org admin
List scheme members
PATCH/api/v1/schemes/{id}/members/{userId}Org admin
Update member role or unit assignment
Method
Path
Auth
Purpose
GET/api/v1/invitations/verify/{token}No
Verify invitation token
POST/api/v1/invitations/verify/{token}/acceptNo
Accept invitation
POST/api/v1/invitationsOrg admin
Create invitation
GET/api/v1/invitationsOrg admin
List invitations
POST/api/v1/invitations/{id}/resendOrg admin
Resend invitation
DELETE/api/v1/invitations/{id}Org admin
Revoke invitation
Method
Path
Auth
Purpose
GET/api/v1/levies/attentionOrg admin
Portfolio attention queue
GET/api/v1/levies/{schemeId}Scheme member or org admin
Levy dashboard
GET/api/v1/levies/{schemeId}/attentionNon-resident scheme member or org admin
Scheme attention queue
GET/api/v1/levies/{schemeId}/accounts/{accountId}/eventsNon-resident scheme member or org admin
Collection event history
POST/api/v1/levies/{schemeId}/accounts/{accountId}/eventsNon-resident scheme member or org admin
Record collection event
GET/api/v1/levies/{schemeId}/accounts/{accountId}/reminder-draftAuthenticated user (current implementation)
Generate reminder draft; current implementation does not enforce scheme membership
POST/api/v1/levies/{schemeId}/accounts/{accountId}/remindersNon-resident scheme member or org admin
Send reminder
POST/api/v1/levies/{schemeId}/periodsOrg admin
Create levy period
POST/api/v1/levies/{schemeId}/reconcileOrg admin
Reconcile payments
POST/api/v1/levies/{schemeId}/reconcile/importsOrg admin
Import bank statement CSV
GET/api/v1/levies/{schemeId}/reconcile/imports/{importId}Org admin
Get bank statement import
POST/api/v1/levies/{schemeId}/reconcile/imports/{importId}/applyOrg admin
Apply bank statement import
Method
Path
Auth
Purpose
GET/api/v1/maintenance/{schemeId}Scheme member or org admin
Maintenance dashboard
POST/api/v1/maintenance/{schemeId}Scheme member or org admin
Create maintenance request
POST/api/v1/maintenance/{schemeId}/{id}/assignNon-resident scheme member or org admin
Assign request
POST/api/v1/maintenance/{schemeId}/{id}/resolveNon-resident scheme member or org admin
Resolve request
Governance/Documents/Reporting
Method
Path
Auth
Purpose
GET/api/v1/agm/{schemeId}Scheme member or org admin
AGM dashboard
POST/api/v1/agm/{schemeId}/meetingsOrg admin
Schedule meeting
POST/api/v1/agm/{schemeId}/meetings/{meetingId}/proxyNon-admin scheme member
Assign proxy
POST/api/v1/agm/{schemeId}/resolutions/{resolutionId}/voteNon-admin scheme member
Cast vote
GET/api/v1/documents/{schemeId}Scheme member or org admin
List documents
POST/api/v1/documents/{schemeId}Org admin
Create document record
DELETE/api/v1/documents/{schemeId}/{id}Org admin
Delete document
GET/api/v1/financials/{schemeId}Scheme member or org admin
Financial dashboard
PUT/api/v1/financials/{schemeId}/budget-linesNon-resident scheme member or org admin
Upsert budget line
PUT/api/v1/financials/{schemeId}/reserve-fundNon-resident scheme member or org admin
Update reserve fund
Communications/Compliance/WhatsApp/Contractors
Method
Path
Auth
Purpose
GET/api/v1/communications/{schemeId}Scheme member or org admin
List communications
POST/api/v1/communications/{schemeId}Non-resident scheme member or org admin
Create communication
GET/api/v1/compliance/portfolioOrg admin
Portfolio compliance dashboard
GET/api/v1/compliance/{schemeId}Non-resident scheme member or org admin
Compliance dashboard
POST/api/v1/compliance/{schemeId}/assessNon-resident scheme member or org admin
Create compliance assessment
POST/api/v1/compliance/{schemeId}/itemsNon-resident scheme member or org admin
Create compliance item
PUT/api/v1/compliance/{schemeId}/items/{itemId}Non-resident scheme member or org admin
Update compliance item
DELETE/api/v1/compliance/{schemeId}/items/{itemId}Non-resident scheme member or org admin
Delete compliance item
GET/api/v1/whatsapp/{schemeId}Scheme member or org admin
WhatsApp dashboard
POST/api/v1/whatsapp/{schemeId}/broadcastsNon-resident scheme member or org admin
Create broadcast
POST/api/v1/whatsapp/{schemeId}/messages/{messageId}/maintenance-requestNon-resident scheme member or org admin
Convert WhatsApp message to maintenance request
PATCH/api/v1/whatsapp/{schemeId}/maintenance-intakes/{intakeId}Non-resident scheme member or org admin
Dismiss maintenance intake
GET/api/v1/contractorsOrg admin, or non-resident with scheme access
List contractors; non-admin callers must pass scheme_id
POST/api/v1/contractorsOrg admin
Create contractor
GET/api/v1/contractors/marketplaceOrg admin, or non-resident with scheme access
Search marketplace contractors; callers must pass scheme_id
PATCH/api/v1/contractors/{contractorId}Org admin
Update contractor
POST/api/v1/contractors/{contractorId}/reviewsOrg admin, or non-resident with scheme access
Create contractor review
Billing/Early Access/AI/Audit/Integrations
Method
Path
Auth
Purpose
POST/api/v1/billing/checkoutOrg admin
Create Stripe checkout session
POST/api/v1/billing/portalOrg admin
Create Stripe portal session
GET/api/v1/billing/subscriptionOrg admin
Get subscription state
POST/api/v1/billing/webhooks/stripeNo
Stripe webhook
POST/api/v1/early-accessNo
Submit early-access request
GET/api/v1/early-access/{id}/approveSigned link
Approve page
POST/api/v1/early-access/{id}/approveSigned link
Approve request
GET/api/v1/early-access/{id}/rejectSigned link
Reject page
POST/api/v1/early-access/{id}/rejectSigned link
Reject request
GET/api/v1/admin/early-accessOrg admin with configured admin email
List early-access requests
POST/api/v1/admin/early-access/{id}/approveOrg admin with configured admin email
Approve request
POST/api/v1/admin/early-access/{id}/rejectOrg admin with configured admin email
Reject request
POST/api/v1/ai/copilotOrg admin for portfolio scope; non-resident scheme member or org admin with scheme access for scheme scope
AI copilot response
GET/api/v1/audit/schemes/{schemeId}/eventsAdmin or trustee
List scheme audit events
GET/api/v1/integrations/api-clientsOrg admin
List API clients
POST/api/v1/integrations/api-clientsOrg admin
Create API client
DELETE/api/v1/integrations/api-clients/{clientId}Org admin
Revoke API client
GET/api/v1/whatsapp/webhooksNo
Verify inbound WhatsApp webhook
POST/api/v1/whatsapp/webhooksNo
Receive inbound WhatsApp webhook payloads
Open API routes are mounted under /api/open/v1. The OpenAPI document is public; resource endpoints require API-key authentication.
Method
Path
Auth
Purpose
GET/api/open/v1/openapi.jsonNo
OpenAPI document
GET/api/open/v1/schemesAPI key (read:schemes)
List permitted schemes
GET/api/open/v1/schemes/{schemeId}API key (read:schemes + scheme grant)
Get scheme
GET/api/open/v1/schemes/{schemeId}/unitsAPI key (read:schemes + scheme grant)
List units
GET/api/open/v1/schemes/{schemeId}/levy-periodsAPI key (read:schemes + scheme grant)
List levy periods
GET/api/open/v1/schemes/{schemeId}/levy-accountsAPI key (read:levies + scheme grant)
List levy accounts
GET/api/open/v1/schemes/{schemeId}/levy-paymentsAPI key (read:levies + scheme grant)
List levy payments
GET/api/open/v1/schemes/{schemeId}/financialsAPI key (read:financials + scheme grant)
Financial summary