Migrating from V2
A detailed migration guide endpoint per endpoint will be provided after getting out of alpha.
📘 Welcome to the OCUS API migration guide.
Our API has evolved to provide a more robust, secure, and developer-friendly experience. This document outlines the key differences between v2 and v3 to help you transition smoothly to the new version.
Key Benefits of v3
- Better Performance: Increased rate limits and optimized endpoints
- Simplified Integration: Cleaner endpoints structure and standardized responses
- Better Error Handling: More detailed error messages and status codes
Breaking Changes
Before starting your migration, be aware that v3 introduces several breaking changes:
- Authentication mechanism has changed from Bearer tokens to API keys
- Some parameters have been renamed or restructured
- Response formats have been standardized across all endpoints
FAQ
How do I get the organizations my API user belongs to (like /v2/members/me?include=organizations in V2)?
In V3, API keys are scoped to organizations, not users. That means:
- Each API key is tied to a single organization.
- Once you use a key, all requests are automatically scoped to that org.
- There’s no endpoint to list all your organizations in V3.
- To work with multiple orgs, you’ll need separate API keys for each one.
Updated 3 months ago