About API Docs
What this documentation covers and the platform-wide behaviour shared by every module.
About this documentation
This reference shows how the Sulus platform works under the hood. Everything the dashboard does goes through the endpoints documented here, module by module — each with its exact fields, which are required or nullable, the validation limits, the database columns behind them, and the precise responses the system returns.
How requests are authenticated
Every request into the system carries a Personal Access Token as a bearer header:
Authorization: Bearer 1234|users-tokenThe system issues tokens from the dashboard’s Developer page (/developer). A token acts as the user it belongs to — what it can see and change is always identical to what that user sees in the dashboard. This applies to every module in this documentation.
Responses every module shares
| Status | When | Exact body |
|---|---|---|
401 | Missing or invalid token | {"message":"Unauthenticated."} |
403 | The module’s feature is not enabled for the account | {"message":"This feature is not enabled for your account. Please contact your administrator.","feature":"<key>"} |
409 | Account email not verified | {"message":"Your email address is not verified. Please verify your email to continue.","code":"EMAIL_NOT_VERIFIED"} — verifying the email clears it |
422 | Validation failed | {"message":"…","errors":{"field":["…"]}} |
429 | Rate limited | back off and retry |
Module-specific behaviour (envelopes, limits, extra statuses) is documented inside each module.