Conventions used across the entire Public API.Documentation Index
Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt
Use this file to discover all available pages before exploring further.
Time and dates
All timestamps are ISO 8601 in UTC unless explicitly noted:YYYY-MM-DD.
Identifiers
- Resource IDs are positive integers.
- Country IDs use GeoNames numeric IDs:
6252001(US),2635167(GB). Full list:GET /api/v2/common/lists/countries.
Currencies and monetary values
- Currency codes follow ISO 4217:
USD,EUR,GBP. - Monetary amounts have up to 4 decimal places:
12.5000. Display rounding is the client’s responsibility.
Status values
Many resources use a numericstatus field:
| Value | Meaning |
|---|---|
1 | Active |
2 | Disabled / Inactive |
3 | Pending review |
4 | Rejected |
Booleans
JSON booleans are always nativetrue / false. Some legacy filters
accept 1 / 0 as a fallback — prefer native booleans.
Null and empty values
- Optional fields absent from the record are returned as
null, not omitted. - Empty collections: arrays as
[], objects as{}. - In
POST/PUTbodies:nullclears the field; omitting the key keeps the current value (unless noted in the endpoint description).