REST API
Admin API

Admin API

These routes are for platform administrators. They require an authenticated admin token with admin MFA enabled and are separate from store owner operations. Do not expose an admin token in a browser or mobile client.

Route index

AreaRoutes
DashboardGET /admin/dashboard
OrganisationsGET /admin/organisations, GET /admin/organisations/{id}, GET /admin/organisations/{id}/stores, GET /admin/organisations/{id}/users, PATCH /admin/organisations/{id}
Users and storesGET /admin/users, PATCH /admin/users/{id}, GET /admin/stores, PATCH /admin/stores/{id}
Catalog and salesGET /admin/products, GET /admin/products/{id}, PATCH /admin/products/{id}, GET /admin/categories, POST /admin/categories, PATCH /admin/categories/{id}, DELETE /admin/categories/{id}, GET /admin/transactions, GET /admin/transactions/{id}, GET /admin/transactions/summary
Business recordsGET /admin/customers, GET /admin/credits, GET /admin/suppliers, GET /admin/suppliers/{id}/deliveries, GET /admin/suppliers/{id}/payments, GET /admin/expenses
Platform recordsGET /admin/reviews, PATCH /admin/reviews/{id}, DELETE /admin/reviews/{id}, GET /admin/notes, GET /admin/notifications, GET /admin/ai/usage, GET /admin/subscriptions, GET /admin/analytics/overview
MonitoringGET /admin/monitoring/overview, GET /admin/monitoring/activity, GET /admin/monitoring/health

The route index describes registered paths. Query parameters, filters, and response shapes vary by handler; consult the API implementation and API-owned route reference (opens in a new tab) before integrating.

Authentication setup

Admin MFA routes live under /accounts/mfa/totp and are documented in Authentication. Admin-only subscription management routes use /subscriptions/admin/plans and related endpoints; see Subscriptions.