Admin: Tenants API
Platform-admin (SUPERADMIN / SUPPORT) endpoints for tenant management. Calls require a platform-admin JWT — regular tenant users get HTTP 403.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | `/api/v1/admin/tenants` | List |
| GET | `/api/v1/admin/tenants/:id` | Detail |
| POST | `/api/v1/admin/tenants/:id/suspend` | Suspend |
| POST | `/api/v1/admin/tenants/:id/unsuspend` | Unsuspend |
| POST | `/api/v1/admin/tenants/:id/impersonate` | Mint a 5-min impersonation token |
| ANY | `/api/v1/admin/tenants/:id/export` | Tenant export job |
| ANY | `/api/v1/admin/tenants/:id/export/:jobId` | Poll export job |
| GET | `/api/v1/admin/users` | Search users |
| GET | `/api/v1/admin/audit` | Audit log |
| GET | `/api/v1/admin/me` | Caller's platform role |
Every response uses the standard envelope:
{
"success": true,
"data": { /* resource or array */ },
"meta": { "total": 100, "cursor": "...", "hasMore": true },
"error": { "code": "ERROR_CODE", "message": "Human readable" }
}error is omitted on success; meta is omitted when not paginating.
Rate Limits
Subject to the standard 200 req/min/tenant authenticated limit. See [Rate Limits](/docs/api-reference/rate-limits) for full details and the per-endpoint overrides.