Skip to main content
Conventions used across the entire Public API.

​
Time and dates

All timestamps are ISO 8601 in UTC unless explicitly noted: 
2026-01-20T13:45:00Z
Date-only fields (report ranges, billing periods) use 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 numeric status field:
ValueMeaning
1Active
2Disabled / Inactive
3Pending review
4Rejected
Per-endpoint documentation lists the exact allowed values.

​
Booleans

JSON booleans are always native true / 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 / PUT bodies: null clears the field; omitting the key keeps the current value (unless noted in the endpoint description).

​
Localisation

Display strings are returned in the network’s configured primary language. There is no per-request locale override.