Guides

Context and tenancy

Some endpoints act on "the active context" rather than a resource in the path, for example GET /v1/me/context and GET /v1/audit. Choose it with the x-odin-context header:

Value Meaning
partner:<partnerId> Your whole partner account
organization:<organizationId> One employer customer
entity:<entityId> One payroll entity

GET /v1/me/context returns the resolved scope, the scopes you hold there (for example payroll:admin), and the feature toggles that apply. Use it to decide what to show in your own UI.

Feature toggles

Partner administrators can turn areas of the product off for their partner. When an area is off, its endpoints return 403 with code feature_disabled, whoever calls them.