Versioning

How the API changes, and how you'll hear about it.

The version is in the path: /api/v1. Within v1, Onym only makes additive changes without notice:

• New endpoints
• New optional parameters
• New fields in responses
• New values in enums, like a new change kind or a new surface
• New error codes

Write clients that ignore fields and values they don't recognize.

Breaking changes, like removing or renaming a field or changing its type, are announced in the changelog and by email to workspace admins at least 30 days ahead. Larger redesigns will ship as /api/v2, with v1 kept running alongside.

Webhook payloads follow the same rules.