Admin Endpoints (v1)

This section documents all admin system endpoints. These endpoints are used for platform administration and management.

note

Important: Admin endpoints require admin authentication. Use the Admin Authentication endpoints to obtain admin tokens.

Dashboard

• Get Dashboard Overview - Platform dashboard statistics (including basic + add-on subscriber count excluding free-only), attention orders
• Get Dashboard Revenue - Get detailed revenue, expenses, and net income data with time-series breakdown (today, week, month, or custom date range)

Workspaces

• List Workspaces - Get all workspaces with filtering and pagination
• Get Workspace - Get a single workspace by ID
• Update workspace plan - Assign an active plan to a workspace
• Create workspace impersonation login token - Super-admin: mint a one-time token for client-system owner login
• Clone Workspace - Create a new workspace account copying settings from an existing workspace
• Get Workspace Storage Usage - Get storage usage summary for a workspace
• Update Workspace Referral - Assign or remove a referral for a workspace
• Update Workspace PWA Install - Enable/disable storefront app install per workspace

Workspace Menus

• Get Workspace Menu Override - Get workspace menu configuration
• Update Workspace Menu Override - Update workspace menu allowed sections
• Delete Workspace Menu Override - Remove workspace menu override

Settings

• Get Settings - Get platform settings
• Update Settings - Update platform settings

Plans

• List Plans - Get all subscription plans
• Create Plan - Create a new subscription plan
• Get Plan - Get a single plan by ID
• Update Plan - Update a subscription plan
• Upload Plan Asset - Upload plan image asset

Business Categories

• Get Business Categories Meta - Get metadata for business categories
• List Business Categories - Get all business categories with filtering
• Create Business Category - Create a new business category
• Get Business Category - Get a single business category by ID
• Update Business Category - Update a business category
• Delete Business Category - Delete a business category
• Upload Business Category Asset - Upload business category image asset

Admins

• Get Admins Meta - Get admin roles and permissions metadata
• List Admins - Get all admin users with filtering
• Create Admin - Create a new admin account
• Get Admin - Get a single admin by ID
• Update Admin - Update an admin account

Logs

• List Logs - Get system audit logs with filtering

Imports

• Run Ivana Laser Import - Import Ivana laser sessions with cache support

Placio Subscriptions

• Placio Subscriptions Management - Track subscription balances and service provider accounts for Placio services

Payments

• List Payments - Get all workspace payments with filtering and pagination
• Get Payment Statistics - Get payment statistics (total, monthly, weekly, daily)
• Create Manual Payment - Create a new manual payment record
• Update Manual Payment - Update an existing manual payment
• Delete Manual Payment - Delete a manual payment record

Expenses

• List Expenses - Get all platform expenses with filtering and pagination
• Get Expense Statistics - Get expense statistics (total, monthly, weekly, daily) and breakdown by category
• Create Expense - Create a new expense record
• Get Expense - Get a single expense by ID
• Update Expense - Update an existing expense
• Delete Expense - Delete an expense record
• Upload Expense Receipt - Upload a receipt image for an expense

Referrals

• List Referrals - List admin referrals with pagination
• Get Referral - Get a single referral by ID
• Create Referral - Create a new referral
• Update Referral - Update a referral
• Delete Referral - Delete a referral
• List Referral Workspaces - List workspaces under a referral