Skip to content

hailer.admin

Internal

These endpoints back Hailer's own instance-administration tooling and require admin authorization on the host. They are documented for completeness and are not intended for third-party apps.

Every method calls an admin.* host op, which the host proxies to the corresponding internal v3.admin.* operation.

Workspaces

MethodHost opReturns
listWorkspaces(request?)admin.workspace.listPromise<AdminWorkspaceListResponse>
getWorkspace(workspaceId)admin.workspace.getPromise<AdminWorkspace>
createStripeSession(request)admin.workspace.createStripeSessionPromise<AdminCreateStripeSessionResponse>
createInvoiceIntegration(request)admin.workspace.createInvoiceIntegrationPromise<AdminCreateInvoiceIntegrationResponse>
updateWorkspaceSubscription(request)admin.workspace.updateSubscriptionPromise<boolean>
updateTokenBalance(request)admin.workspace.updateTokenBalancePromise<boolean>
updateWorkspaceOverrides(request)admin.workspace.updateOverridesPromise<boolean>
updateWorkspaceMarketplaceSettings(request)admin.workspace.updateMarketplaceSettingsPromise<boolean>
listWorkspaceUsers(request)admin.workspace.listUsersPromise<AdminWorkspaceUsersListResponse>

updateTokenBalance takes { workspaceId, tokenAmount, payoutMonth?, payoutYear?, payoutType?: 'admin_bonus' | 'creator_payout', creatorPercent? }.

Users

MethodHost opReturns
updateUser(request)admin.user.updatePromise<boolean>

Purchases & invoices

MethodHost opReturns
updatePurchasePrice(request)admin.purchase.updatePricePromise<boolean>
listInvoices(request?)admin.invoice.listPromise<AdminInvoiceListResponse>
updateInvoiceHandled(request)admin.invoice.updateHandledPromise<AdminInvoiceUpdateHandledResponse>
setSubscriptionActivityId(purchaseId, subscriptionActivityId)admin.invoice.setSubscriptionActivityIdPromise<boolean>

Revenue & token transactions

MethodHost opReturns
listMonthlyRevenue(request)admin.revenue.listPromise<AdminRevenueListResponse>
listTokenTransactions(request?)admin.tokenTransaction.listPromise<AdminTokenTransactionsListResponse>

listMonthlyRevenue sends [month, year, filter, options].

Dashboard

MethodHost opReturns
getDashboardStatistics(entities?)admin.dashboard.statisticsPromise<AdminDashboardStatisticsResponse>
getDashboardTrends(days?, entities?)admin.dashboard.trendsPromise<AdminDashboardTrendsResponse>

getDashboardTrends accepts days of 30 | 90 | 180 | 365 and an optional entities array.

hailer.admin.referral

MethodHost opReturns
listCodes(request?)admin.referral.listCodesPromise<AdminReferralCodeListResponse>
listEvents(request?)admin.referral.listEventsPromise<AdminReferralEventListResponse>
updateCode(codeId, updates)admin.referral.updateCodePromise<boolean>

updateCode takes { bonusTokens?, isActive? } and sends { codeId, ...updates }.

Request/response shapes are catalogued in the Types reference.

Hailer Developer Documentation