Fields

All fields are required unless marked as nullable or optional.

• Nullable fields can return null.
• Optional fields can be omitted entirely from the response.

Types

• number
  Examples: 10, 10.52
• string
• object (See Common Types or individual resource definitions)
• boolean
• enum
  A predefined set of valid values

IDs

All resource IDs are ULIDs — 26-character, case-insensitive strings that sort chronologically. Treat them as opaque strings (they are not UUIDs):

{
"id": "01J5X3Y8ZK2Q4R6T8V0W2X4Y6Z"
}

Timestamps

Timestamps follow the ATOM format (RFC 3339, second precision, numeric UTC offset — always +00:00, the API works in UTC); the fields are camelCase and end with At:

{
"createdAt": "2024-12-21T10:41:59+00:00"
}

Phone Numbers

Phone numbers must be in international format (E.164) with a leading + and country code. The number is validated against Google's libphonenumber database for the given country.

{
  "phone": "+421901234567"
}

Valid examples:

Country	Format
Slovakia	+421901234567
Czechia	+420601234567
USA	+12025551234
UK	+447911123456
Germany	+4915112345678

WARNING

Numbers without a country code (e.g., 0901234567) will be rejected.

Enums

Some fields (e.g., state or type) have predefined sets of values. Each resource section specifies its valid enums:

{
"state": "pending"
}