Skip to content
MailcycleMailcycleMailcycle Docs

Conventions

  • Base URL: https://api.mailcycle.email
  • JSON in, JSON out. Send Content-Type: application/json on every request with a body.
  • Identifiers are prefixed and opaque: acct_ accounts, ibx_ email addresses, msg_ messages, wkr_ devices, key_ API keys. API key tokens start with mak_.
  • Client-chosen ids. Records that carry sealed data bound to their id (addresses, messages, devices, API keys) take an id you generate, so the seal can exist before the record. The server checks the shape and uniqueness.
  • Timestamps are ISO 8601 in UTC.
  • Money is integer minor units: 9900 is $99.00.
  • Pagination. GET /workers and GET /inboxes/:id/messages take ?limit= (default 50, at most 200) and ?cursor= from the previous response’s nextCursor. A null nextCursor means the end.
  • Ownership. A record you do not own answers 404, the same as one that does not exist.