Skip to content

Admin API Endpoints

Admin APIs cover tenant-level lab administration (/lab/admin) and platform-level operations (/admin).

Tenant admin (/lab/admin)

Requires JWT with tenant context. Most endpoints check specific permissions.

Access and roles

MethodEndpointPermissionDescription
GET/lab/admin/accessCurrent user's roles and permissions
GET/lab/admin/permissionsroles.viewPermission catalog
GET/lab/admin/rolesroles.viewList roles
POST/lab/admin/rolesroles.createCreate role
PUT/lab/admin/roles/{id}roles.editUpdate role
DELETE/lab/admin/roles/{id}roles.deleteDelete role

Users

MethodEndpointPermissionDescription
GET/lab/admin/usersusers.viewList staff
POST/lab/admin/usersusers.createCreate staff user
PUT/lab/admin/users/{id}users.editUpdate user
DELETE/lab/admin/users/{id}users.deleteDeactivate user

CRM, stock, ledgers

Additional routes under /lab/admin/crm, /lab/settings, and related controllers follow the same permission pattern. See Lab Administration.

Platform admin (/admin)

Requires platform admin JWT.

Tenants

MethodEndpointPermissionDescription
GET/admin/tenantsplatform.tenants.viewList tenants
GET/admin/tenants/{id}platform.tenants.viewTenant detail
POST/admin/tenantsplatform.tenants.manageCreate tenant
PUT/admin/tenants/{id}platform.tenants.manageUpdate tenant
POST/admin/tenants/{id}/lockplatform.tenants.manageLock tenant
POST/admin/tenants/{id}/unlockplatform.tenants.manageUnlock tenant
POST/admin/tenants/{id}/provisionplatform.tenants.manageProvision database
POST/admin/tenants/{id}/impersonateplatform.tenants.impersonateStart impersonation

Custom domain

MethodEndpointDescription
GET/admin/tenants/{id}/custom-domainCurrent domain config
POST/admin/tenants/{id}/custom-domainSet hostname
POST/admin/tenants/{id}/custom-domain/verifyVerify DNS
DELETE/admin/tenants/{id}/custom-domainRemove domain

Plans

MethodEndpointPermission
GET/POST/PUT/admin/plansplatform.plans.manage

Backups

MethodEndpointPermission
GET/PUT/admin/backups/settingsplatform.backups.manage
GET/POST/admin/backupsplatform.backups.manage
POST/admin/backups/{id}/restoreplatform.backups.manage

Platform settings

MethodEndpointPermission
GET/PUT/admin/settings/payment-accountplatform.tenants.billing
GET/PUT/admin/settings/registration-email-policyplatform.tenants.manage

Platform CRM

MethodEndpointPermission
CRUD/admin/crm/leadsplatform.crm.manage

Platform users

MethodEndpointPermission
CRUD/admin/usersplatform.users.manage

Tenant owner routes (/tenant)

MethodEndpointDescription
GET/tenant/backupsList tenant's backups
POST/tenant/backups/{id}/restoreOwner restore

Reports

PrefixDescription
/lab/pms/reportsTenant operational/financial reports
/admin/reportsPlatform-wide reports
/admin/analyticsPlatform analytics

Ease Lab — Cloud Pathology Lab Management