API Reference
Organization

Organization

The organization endpoints are deliberately small - they cover reading your org's basic record and renaming it. Plan and subscription details live under billing, not here.


Get organization

GET /api/organizations/me

Returns the current organization's details, or null if the authenticated user isn't attached to an org.

Response 200 OK

{
  "id": "org_xyz",
  "name": "Acme Corp",
  "plan": "team",
  "plan_status": "active",
  "deletion_scheduled_at": null,
  "had_subscription_before_deletion": false
}

deletion_scheduled_at is set when an org has requested account deletion and is in its grace period; had_subscription_before_deletion records whether it had a paid plan at the time.


Update organization

PATCH /api/organizations/me

Required role: Super Admin

Request body

{
  "name": "Acme Corporation"
}

name is required, must be non-blank, and can't exceed 100 characters.

Response 200 OK - the updated organization row.


Plan and usage

There's no /api/organizations/me/usage endpoint. For plan and subscription state, see GET /api/billing/subscription, which returns the org's effective plan, billing interval, and Stripe subscription status. It doesn't report usage counts (employees, assets, etc.) against plan limits - those are enforced server-side at write time. Hit a limit and you'll get a 403 with details in the body (shape varies by resource - creating an offboarding returns { error, code: 'PLAN_LIMIT_REACHED', plan, limit, activeCount }, creating an asset returns { error, currentCount, maxAssets, upgradeRequired: true }) rather than a dedicated usage report.