Admin

Further staff-only administrative operations, grouped into four domains:

  • Billing: cancel a subscription, issue a refund, retry a failed payment. All are carried out against the payment provider and the local view is kept in step with it.
  • User lifecycle: send a password reset, suspend or ban, reinstate, change a user's role within their organisation.
  • Erasure: delete a user under GDPR Article 17, or erase an organisation and its data after its retention window has closed. Organisation erasure is a controller disposal at window close, not an Article 17 right-to-be-forgotten; hard deletion of an organisation is disabled in favour of the sanctioned routine.
  • Operational: re-queue failed inbound webhook events, list recent failures, clear the server's in-memory caches.

Every endpoint requires staff (admin) authority and is recorded in the administrative audit log.

Endpoints

GEThttps://app.speybooks.com/api/v1/admin/audit-logView audit logDELETEhttps://app.speybooks.com/api/v1/admin/bug-reports/Bulk delete bug reportsDELETEhttps://app.speybooks.com/api/v1/admin/bug-reports/{id}Delete a bug reportGEThttps://app.speybooks.com/api/v1/admin/orgsList organisationsGEThttps://app.speybooks.com/api/v1/admin/orgs/{id}Get organisation detailsPATCHhttps://app.speybooks.com/api/v1/admin/orgs/{id}Update organisationDELETEhttps://app.speybooks.com/api/v1/admin/orgs/{id}Delete organisation (disabled)POSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/cancel-subscriptionCancel subscriptionPOSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/deactivateDeactivate organisationPOSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/eraseErase organisation (post-window)POSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/reactivateReactivate organisationPOSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/refundRefund paymentPOSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/retry-paymentRetry paymentGEThttps://app.speybooks.com/api/v1/admin/searchSearch platformGEThttps://app.speybooks.com/api/v1/admin/settingsGet platform settingsPATCHhttps://app.speybooks.com/api/v1/admin/settings/{key}Update platform settingGEThttps://app.speybooks.com/api/v1/admin/statsPlatform statisticsPOSThttps://app.speybooks.com/api/v1/admin/system/clear-cacheClear system cacheGEThttps://app.speybooks.com/api/v1/admin/system/healthSystem health checkPOSThttps://app.speybooks.com/api/v1/admin/system/replay-webhooksReplay failed webhooksGEThttps://app.speybooks.com/api/v1/admin/system/webhooks/failedList failed webhooksGEThttps://app.speybooks.com/api/v1/admin/usersList usersGEThttps://app.speybooks.com/api/v1/admin/users/{id}Get user detailsDELETEhttps://app.speybooks.com/api/v1/admin/users/{id}Delete userPOSThttps://app.speybooks.com/api/v1/admin/users/{id}/disable-mfaDisable user MFAPOSThttps://app.speybooks.com/api/v1/admin/users/{id}/impersonateImpersonate userPATCHhttps://app.speybooks.com/api/v1/admin/users/{id}/roleUpdate user rolePOSThttps://app.speybooks.com/api/v1/admin/users/{id}/send-reset-linkSend password resetPOSThttps://app.speybooks.com/api/v1/admin/users/{id}/suspendSuspend userPOSThttps://app.speybooks.com/api/v1/admin/users/{id}/unlockUnlock userPOSThttps://app.speybooks.com/api/v1/admin/users/{id}/unsuspendUnsuspend user