CohabitDeveloper Portal
Docs menu · Conventions

Conventions

A few conventions apply across every Cohabit API and this portal itself.

  • JSON everywhere. Requests and responses are application/json unless documented otherwise.
  • Timestamps are RFC 3339 with a trailing Z (UTC) — e.g. 2026-08-04T15:52:45Z. Parse them as UTC, never local time.
  • Identifiers vary by API. Product endpoints key on the strata plan number (SP82487, case-insensitive). Cohabit Authentication (OIDC) resources use UUIDs.
  • Errors come in two shapes. The product API follows RFC 9457 (application/problem+json: type/title/status/detail + a stable code) — match on code (full table in the API reference). OIDC endpoints return the OAuth 2.0 shape { "error", "error_description" }.
  • Versioning. Every product endpoint lives under /v1. Additive changes ship without a version bump, so tolerate unknown fields; breaking changes ship under a new version with a stated support window.