# API reference

URL: https://docs.spacerun.co/docs/platform/reference

> Every published Platform API operation, grouped by tag.

Base URL: `http://localhost:8787`

## Device authorization

See the [workflow guide](/docs/platform/guides/device-authorization) for prerequisites and examples.

- [List the caller's device authorizations](https://docs.spacerun.co/docs/platform/reference/device-authorization/listDeviceAuthorizations.md): `GET /v1/me/device-authorizations`
- [Revoke a device authorization](https://docs.spacerun.co/docs/platform/reference/device-authorization/revokeDeviceAuthorization.md): `DELETE /v1/me/device-authorizations/{id}`
- [Approve, deny or inspect a device code](https://docs.spacerun.co/docs/platform/reference/device-authorization/respondDeviceAuthorization.md): `POST /v1/me/device/approve`
- [Start a device authorization](https://docs.spacerun.co/docs/platform/reference/device-authorization/createDeviceCode.md): `POST /v1/public/device/code`
- [Poll for the device authorization result](https://docs.spacerun.co/docs/platform/reference/device-authorization/exchangeDeviceCode.md): `POST /v1/public/device/token`

## Email unsubscribe

See the [workflow guide](/docs/platform/guides/email-campaigns) for prerequisites and examples.

- [Unsubscribe via link](https://docs.spacerun.co/docs/platform/reference/email-unsubscribe/unsubscribeEmailByLink.md): `GET /v1/public/email/unsubscribe`
- [Unsubscribe (RFC 8058 one-click)](https://docs.spacerun.co/docs/platform/reference/email-unsubscribe/unsubscribeEmailOneClick.md): `POST /v1/public/email/unsubscribe`

## Public site

See the [workflow guide](/docs/platform/guides/support-and-public-api) for prerequisites and examples.

- [List the public product catalog](https://docs.spacerun.co/docs/platform/reference/public-site/listPublicProducts.md): `GET /v1/public/products`
- [Get published site configuration](https://docs.spacerun.co/docs/platform/reference/public-site/getPublicSite.md): `GET /v1/public/site`
- [Join the waitlist](https://docs.spacerun.co/docs/platform/reference/public-site/joinWaitlist.md): `POST /v1/public/waitlist`

## Public store

See the [workflow guide](/docs/platform/guides/support-and-public-api) for prerequisites and examples.

- [List published games](https://docs.spacerun.co/docs/platform/reference/public-store/listPublicStoreGames.md): `GET /v1/public/store/games`
- [Get a published game by slug](https://docs.spacerun.co/docs/platform/reference/public-store/getPublicStoreGame.md): `GET /v1/public/store/games/{slug}`

## Account

See the [workflow guide](/docs/platform/guides/profile-and-security) for prerequisites and examples.

- [Request account deletion](https://docs.spacerun.co/docs/platform/reference/account/requestAccountDeletion.md): `POST /v1/me/delete`
- [Confirm account deletion](https://docs.spacerun.co/docs/platform/reference/account/confirmAccountDeletion.md): `POST /v1/me/delete/confirm`

## Billing

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [Get the caller's billing overview](https://docs.spacerun.co/docs/platform/reference/billing/getMyBilling.md): `GET /v1/me/billing`
- [Start a Stripe Checkout session](https://docs.spacerun.co/docs/platform/reference/billing/createCheckoutSession.md): `POST /v1/me/billing/checkout-session`
- [List the caller's Stripe invoices](https://docs.spacerun.co/docs/platform/reference/billing/listMyInvoices.md): `GET /v1/me/billing/invoices`
- [List the caller's credit ledger](https://docs.spacerun.co/docs/platform/reference/billing/listMyCreditLedger.md): `GET /v1/me/billing/ledger`
- [Start a Stripe billing portal session](https://docs.spacerun.co/docs/platform/reference/billing/createBillingPortalSession.md): `POST /v1/me/billing/portal-session`

## Game sessions

See the [workflow guide](/docs/platform/guides/session-lifecycle) for prerequisites and examples.

- [Start a game session](https://docs.spacerun.co/docs/platform/reference/game-sessions/createGameSession.md): `POST /v1/me/sessions`
- [Stop the caller's open sessions](https://docs.spacerun.co/docs/platform/reference/game-sessions/stopGameSessions.md): `POST /v1/me/sessions/stop`

## Profile

See the [workflow guide](/docs/platform/guides/profile-and-security) for prerequisites and examples.

- [Get the caller's profile](https://docs.spacerun.co/docs/platform/reference/profile/getMyProfile.md): `GET /v1/me`
- [Update the caller's profile](https://docs.spacerun.co/docs/platform/reference/profile/updateMyProfile.md): `PATCH /v1/me`
- [Confirm an uploaded avatar](https://docs.spacerun.co/docs/platform/reference/profile/confirmAvatar.md): `POST /v1/me/avatar/confirm`
- [Get a signed avatar upload URL](https://docs.spacerun.co/docs/platform/reference/profile/createAvatarUploadUrl.md): `POST /v1/me/avatar/upload-url`
- [List the caller's permission keys](https://docs.spacerun.co/docs/platform/reference/profile/getMyPermissions.md): `GET /v1/me/permissions`
- [Get realtime subscription credentials](https://docs.spacerun.co/docs/platform/reference/profile/getMyRealtimeAccess.md): `GET /v1/me/realtime`
- [List the caller's login sessions](https://docs.spacerun.co/docs/platform/reference/profile/listMyAuthSessions.md): `GET /v1/me/sessions`
- [Revoke a login session](https://docs.spacerun.co/docs/platform/reference/profile/revokeMyAuthSession.md): `DELETE /v1/me/sessions/{sessionId}`

## Support

See the [workflow guide](/docs/platform/guides/support-and-public-api) for prerequisites and examples.

- [Send a support message](https://docs.spacerun.co/docs/platform/reference/support/sendSupportMessage.md): `POST /v1/me/support`

## Announcements

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List announcements](https://docs.spacerun.co/docs/platform/reference/announcements/listSiteAnnouncements.md): `GET /v1/admin/site/announcements`
- [Create or update an announcement](https://docs.spacerun.co/docs/platform/reference/announcements/upsertSiteAnnouncement.md): `PUT /v1/admin/site/announcements`
- [Get an announcement](https://docs.spacerun.co/docs/platform/reference/announcements/getSiteAnnouncement.md): `GET /v1/admin/site/announcements/{id}`

## Audit log

See the [workflow guide](/docs/platform/guides/operations-and-audit) for prerequisites and examples.

- [List audit events](https://docs.spacerun.co/docs/platform/reference/audit-log/listAuditEvents.md): `GET /v1/admin/audit`
- [List audit filter facets](https://docs.spacerun.co/docs/platform/reference/audit-log/listAuditFacets.md): `GET /v1/admin/audit/facets`

## Billing coupons

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [List coupons](https://docs.spacerun.co/docs/platform/reference/billing-coupons/listBillingCoupons.md): `GET /v1/admin/billing/coupons`
- [Create a coupon](https://docs.spacerun.co/docs/platform/reference/billing-coupons/createBillingCoupon.md): `POST /v1/admin/billing/coupons`
- [Delete a coupon](https://docs.spacerun.co/docs/platform/reference/billing-coupons/deleteBillingCoupon.md): `DELETE /v1/admin/billing/coupons/{id}`
- [List promotion codes](https://docs.spacerun.co/docs/platform/reference/billing-coupons/listBillingPromotionCodes.md): `GET /v1/admin/billing/promotion-codes`
- [Create a promotion code](https://docs.spacerun.co/docs/platform/reference/billing-coupons/createBillingPromotionCode.md): `POST /v1/admin/billing/promotion-codes`
- [Activate or deactivate a promotion code](https://docs.spacerun.co/docs/platform/reference/billing-coupons/updateBillingPromotionCode.md): `PATCH /v1/admin/billing/promotion-codes/{id}`

## Billing credits

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [Gift a credit pack](https://docs.spacerun.co/docs/platform/reference/billing-credits/giftBillingCreditPack.md): `POST /v1/admin/billing/credits/gift-pack`
- [Grant or adjust credits](https://docs.spacerun.co/docs/platform/reference/billing-credits/grantBillingCredits.md): `POST /v1/admin/billing/credits/grant`
- [List giftable tiers](https://docs.spacerun.co/docs/platform/reference/billing-credits/listBillingGiftableTiers.md): `GET /v1/admin/billing/giftable-tiers`
- [List credit ledger](https://docs.spacerun.co/docs/platform/reference/billing-credits/listBillingLedger.md): `GET /v1/admin/billing/ledger`
- [List a user's credit lots](https://docs.spacerun.co/docs/platform/reference/billing-credits/listBillingCreditLots.md): `GET /v1/admin/billing/lots`

## Billing overview

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [Stripe dashboard deep link](https://docs.spacerun.co/docs/platform/reference/billing-overview/getBillingDeepLink.md): `GET /v1/admin/billing/deep-link/{type}/{id}`
- [Billing overview](https://docs.spacerun.co/docs/platform/reference/billing-overview/getBillingOverview.md): `GET /v1/admin/billing/overview`

## Billing payments

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [List invoices (Stripe invoices)](https://docs.spacerun.co/docs/platform/reference/billing-payments/listBillingInvoices.md): `GET /v1/admin/billing/invoices`
- [List payments (Stripe charges)](https://docs.spacerun.co/docs/platform/reference/billing-payments/listBillingPayments.md): `GET /v1/admin/billing/payments`
- [Refund a payment](https://docs.spacerun.co/docs/platform/reference/billing-payments/refundBillingPayment.md): `POST /v1/admin/billing/payments/{id}/refund`

## Billing subscriptions

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [List subscriptions](https://docs.spacerun.co/docs/platform/reference/billing-subscriptions/listBillingSubscriptions.md): `GET /v1/admin/billing/subscriptions`
- [Cancel a subscription](https://docs.spacerun.co/docs/platform/reference/billing-subscriptions/cancelBillingSubscription.md): `POST /v1/admin/billing/subscriptions/{id}/cancel`
- [Resume a subscription](https://docs.spacerun.co/docs/platform/reference/billing-subscriptions/resumeBillingSubscription.md): `POST /v1/admin/billing/subscriptions/{id}/resume`

## Catalog: achievements

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [List achievement definitions](https://docs.spacerun.co/docs/platform/reference/catalog-achievements/listCatalogAchievements.md): `GET /v1/admin/catalog/achievements`
- [Create an achievement definition](https://docs.spacerun.co/docs/platform/reference/catalog-achievements/createCatalogAchievement.md): `POST /v1/admin/catalog/achievements`
- [Delete an achievement definition](https://docs.spacerun.co/docs/platform/reference/catalog-achievements/deleteCatalogAchievement.md): `DELETE /v1/admin/catalog/achievements/{id}`
- [Update an achievement definition](https://docs.spacerun.co/docs/platform/reference/catalog-achievements/updateCatalogAchievement.md): `PATCH /v1/admin/catalog/achievements/{id}`

## Catalog: referral rules

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [Get referral reward rules](https://docs.spacerun.co/docs/platform/reference/catalog-referral-rules/getCatalogReferralRules.md): `GET /v1/admin/catalog/referral-rules`
- [Set referral reward rules](https://docs.spacerun.co/docs/platform/reference/catalog-referral-rules/setCatalogReferralRules.md): `PUT /v1/admin/catalog/referral-rules`

## Content blocks

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List content blocks](https://docs.spacerun.co/docs/platform/reference/content-blocks/listSiteContentBlocks.md): `GET /v1/admin/site/content-blocks`
- [Create or update a content block draft](https://docs.spacerun.co/docs/platform/reference/content-blocks/upsertSiteContentBlock.md): `PUT /v1/admin/site/content-blocks`
- [Get a content block](https://docs.spacerun.co/docs/platform/reference/content-blocks/getSiteContentBlock.md): `GET /v1/admin/site/content-blocks/{id}`
- [Change a content block status](https://docs.spacerun.co/docs/platform/reference/content-blocks/setSiteContentBlockStatus.md): `POST /v1/admin/site/content-blocks/{id}/status`

## Email audiences

See the [workflow guide](/docs/platform/guides/email-campaigns) for prerequisites and examples.

- [List audiences](https://docs.spacerun.co/docs/platform/reference/email-audiences/listEmailAudiences.md): `GET /v1/admin/email/audiences`
- [Create an audience](https://docs.spacerun.co/docs/platform/reference/email-audiences/createEmailAudience.md): `POST /v1/admin/email/audiences`
- [Get an audience](https://docs.spacerun.co/docs/platform/reference/email-audiences/getEmailAudience.md): `GET /v1/admin/email/audiences/{id}`
- [Update an audience](https://docs.spacerun.co/docs/platform/reference/email-audiences/updateEmailAudience.md): `PUT /v1/admin/email/audiences/{id}`
- [Delete an audience](https://docs.spacerun.co/docs/platform/reference/email-audiences/deleteEmailAudience.md): `DELETE /v1/admin/email/audiences/{id}`
- [List audience members](https://docs.spacerun.co/docs/platform/reference/email-audiences/listEmailAudienceMembers.md): `GET /v1/admin/email/audiences/{id}/members`
- [Replace audience members](https://docs.spacerun.co/docs/platform/reference/email-audiences/setEmailAudienceMembers.md): `PUT /v1/admin/email/audiences/{id}/members`
- [Remove an audience member](https://docs.spacerun.co/docs/platform/reference/email-audiences/removeEmailAudienceMember.md): `DELETE /v1/admin/email/audiences/{id}/members/{memberId}`
- [Preview audience size](https://docs.spacerun.co/docs/platform/reference/email-audiences/previewEmailAudienceCount.md): `GET /v1/admin/email/audiences/{id}/preview-count`

## Email campaigns

See the [workflow guide](/docs/platform/guides/email-campaigns) for prerequisites and examples.

- [List campaigns](https://docs.spacerun.co/docs/platform/reference/email-campaigns/listEmailCampaigns.md): `GET /v1/admin/email/campaigns`
- [Create a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/createEmailCampaign.md): `POST /v1/admin/email/campaigns`
- [Get a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/getEmailCampaign.md): `GET /v1/admin/email/campaigns/{id}`
- [Update a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/updateEmailCampaign.md): `PUT /v1/admin/email/campaigns/{id}`
- [Delete a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/deleteEmailCampaign.md): `DELETE /v1/admin/email/campaigns/{id}`
- [Cancel a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/cancelEmailCampaign.md): `POST /v1/admin/email/campaigns/{id}/cancel`
- [List campaign deliveries](https://docs.spacerun.co/docs/platform/reference/email-campaigns/listEmailCampaignDeliveries.md): `GET /v1/admin/email/campaigns/{id}/deliveries`
- [Launch a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/launchEmailCampaign.md): `POST /v1/admin/email/campaigns/{id}/launch`
- [Pause a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/pauseEmailCampaign.md): `POST /v1/admin/email/campaigns/{id}/pause`
- [Get campaign progress](https://docs.spacerun.co/docs/platform/reference/email-campaigns/getEmailCampaignProgress.md): `GET /v1/admin/email/campaigns/{id}/progress`
- [Resume a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/resumeEmailCampaign.md): `POST /v1/admin/email/campaigns/{id}/resume`
- [Schedule a campaign](https://docs.spacerun.co/docs/platform/reference/email-campaigns/scheduleEmailCampaign.md): `POST /v1/admin/email/campaigns/{id}/schedule`
- [Send a campaign test email](https://docs.spacerun.co/docs/platform/reference/email-campaigns/sendEmailCampaignTest.md): `POST /v1/admin/email/campaigns/{id}/test`

## Email deliveries

See the [workflow guide](/docs/platform/guides/email-campaigns) for prerequisites and examples.

- [List email deliveries](https://docs.spacerun.co/docs/platform/reference/email-deliveries/listEmailDeliveries.md): `GET /v1/admin/email/deliveries`

## Email templates

See the [workflow guide](/docs/platform/guides/email-campaigns) for prerequisites and examples.

- [List email templates](https://docs.spacerun.co/docs/platform/reference/email-templates/listEmailTemplates.md): `GET /v1/admin/email/templates`
- [Create an email template](https://docs.spacerun.co/docs/platform/reference/email-templates/createEmailTemplate.md): `POST /v1/admin/email/templates`
- [Get an email template](https://docs.spacerun.co/docs/platform/reference/email-templates/getEmailTemplate.md): `GET /v1/admin/email/templates/{key}`
- [Update email template metadata](https://docs.spacerun.co/docs/platform/reference/email-templates/updateEmailTemplate.md): `PUT /v1/admin/email/templates/{key}`
- [Delete an email template](https://docs.spacerun.co/docs/platform/reference/email-templates/deleteEmailTemplate.md): `DELETE /v1/admin/email/templates/{key}`
- [Diff two template versions](https://docs.spacerun.co/docs/platform/reference/email-templates/diffEmailTemplateVersions.md): `GET /v1/admin/email/templates/{key}/diff`
- [Save a draft version](https://docs.spacerun.co/docs/platform/reference/email-templates/saveEmailTemplateDraft.md): `POST /v1/admin/email/templates/{key}/draft`
- [Render a template preview](https://docs.spacerun.co/docs/platform/reference/email-templates/previewEmailTemplate.md): `POST /v1/admin/email/templates/{key}/preview`
- [Publish a template version](https://docs.spacerun.co/docs/platform/reference/email-templates/publishEmailTemplateVersion.md): `POST /v1/admin/email/templates/{key}/publish`
- [Roll back to a template version](https://docs.spacerun.co/docs/platform/reference/email-templates/rollbackEmailTemplate.md): `POST /v1/admin/email/templates/{key}/rollback`
- [Send a test email](https://docs.spacerun.co/docs/platform/reference/email-templates/sendEmailTemplateTest.md): `POST /v1/admin/email/templates/{key}/test-send`

## Feature flags

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List feature flags](https://docs.spacerun.co/docs/platform/reference/feature-flags/listSiteFlags.md): `GET /v1/admin/site/flags`
- [Create or update a feature flag](https://docs.spacerun.co/docs/platform/reference/feature-flags/upsertSiteFlag.md): `PUT /v1/admin/site/flags/{key}`
- [Delete a feature flag](https://docs.spacerun.co/docs/platform/reference/feature-flags/deleteSiteFlag.md): `DELETE /v1/admin/site/flags/{key}`

## Notifications

See the [workflow guide](/docs/platform/guides/operations-and-audit) for prerequisites and examples.

- [Broadcast an in-app notification and/or email](https://docs.spacerun.co/docs/platform/reference/notifications/broadcastNotification.md): `POST /v1/admin/notifications/broadcast`

## Operations

See the [workflow guide](/docs/platform/guides/operations-and-audit) for prerequisites and examples.

- [List alert subscriptions](https://docs.spacerun.co/docs/platform/reference/operations/listOpsAlertSubscriptions.md): `GET /v1/admin/ops/alert-subscriptions`
- [Replace alert subscriptions](https://docs.spacerun.co/docs/platform/reference/operations/replaceOpsAlertSubscriptions.md): `PUT /v1/admin/ops/alert-subscriptions`
- [Send a test alert email](https://docs.spacerun.co/docs/platform/reference/operations/sendOpsTestAlert.md): `POST /v1/admin/ops/alerts/test`
- [List incidents](https://docs.spacerun.co/docs/platform/reference/operations/listOpsIncidents.md): `GET /v1/admin/ops/incidents`
- [Set panic mode](https://docs.spacerun.co/docs/platform/reference/operations/setOpsPanicMode.md): `POST /v1/admin/ops/panic`
- [Get operational status](https://docs.spacerun.co/docs/platform/reference/operations/getOpsStatus.md): `GET /v1/admin/ops/status`

## Plans and pricing

See the [workflow guide](/docs/platform/guides/billing-checkout) for prerequisites and examples.

- [Create or update a credit pack](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/upsertPlanCreditPack.md): `PUT /v1/admin/plans/credit-packs`
- [Create a Stripe price](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/createPlanPrice.md): `POST /v1/admin/plans/prices`
- [Archive a Stripe price](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/archivePlanPrice.md): `POST /v1/admin/plans/prices/archive`
- [List products](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/listPlanProducts.md): `GET /v1/admin/plans/products`
- [Create or update a product](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/upsertPlanProduct.md): `POST /v1/admin/plans/products`
- [Get a product](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/getPlanProduct.md): `GET /v1/admin/plans/products/{id}`
- [List a product's Stripe prices](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/listPlanProductPrices.md): `GET /v1/admin/plans/products/{id}/prices`
- [Update a product's Stripe object](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/updatePlanStripeProduct.md): `PATCH /v1/admin/plans/products/{id}/stripe`
- [Create a product in Stripe and link it](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/createPlanStripeProduct.md): `POST /v1/admin/plans/products/stripe`
- [List rulesets](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/listPlanRulesets.md): `GET /v1/admin/plans/rulesets`
- [Create or update a ruleset](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/upsertPlanRuleset.md): `PUT /v1/admin/plans/rulesets`
- [List the Stripe catalog](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/getPlanStripeCatalog.md): `GET /v1/admin/plans/stripe-catalog`
- [Migrate subscribers to a new price](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/migratePlanSubscribers.md): `POST /v1/admin/plans/subscribers/migrate`
- [List tiers](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/listPlanTiers.md): `GET /v1/admin/plans/tiers`
- [Create or update a tier](https://docs.spacerun.co/docs/platform/reference/plans-and-pricing/upsertPlanTier.md): `PUT /v1/admin/plans/tiers`

## Roles

See the [workflow guide](/docs/platform/guides/staff-permissions) for prerequisites and examples.

- [List roles](https://docs.spacerun.co/docs/platform/reference/roles/listAdminRoles.md): `GET /v1/admin/roles`
- [Create a role](https://docs.spacerun.co/docs/platform/reference/roles/createAdminRole.md): `POST /v1/admin/roles`
- [Delete a role](https://docs.spacerun.co/docs/platform/reference/roles/deleteAdminRole.md): `DELETE /v1/admin/roles/{id}`
- [Update a role](https://docs.spacerun.co/docs/platform/reference/roles/updateAdminRole.md): `PATCH /v1/admin/roles/{id}`
- [List members of a role](https://docs.spacerun.co/docs/platform/reference/roles/listAdminRoleMembers.md): `GET /v1/admin/roles/{id}/members`
- [Replace a role's permissions](https://docs.spacerun.co/docs/platform/reference/roles/setAdminRolePermissions.md): `PUT /v1/admin/roles/{id}/permissions`
- [Grant a role to a user](https://docs.spacerun.co/docs/platform/reference/roles/assignAdminRole.md): `POST /v1/admin/roles/assign`
- [Get the role/permission matrix](https://docs.spacerun.co/docs/platform/reference/roles/getAdminPermissionMatrix.md): `GET /v1/admin/roles/permissions`
- [Revoke a role from a user](https://docs.spacerun.co/docs/platform/reference/roles/revokeAdminRole.md): `POST /v1/admin/roles/revoke`
- [List a user's current roles](https://docs.spacerun.co/docs/platform/reference/roles/listAdminUserRoles.md): `GET /v1/admin/roles/user/{userId}`

## Runtime API keys

See the [workflow guide](/docs/platform/guides/runtime-management) for prerequisites and examples.

- [List runtime API keys](https://docs.spacerun.co/docs/platform/reference/runtime-api-keys/listRuntimeApiKeys.md): `GET /v1/admin/runtime/api-keys`
- [Create a runtime API key](https://docs.spacerun.co/docs/platform/reference/runtime-api-keys/createRuntimeApiKey.md): `POST /v1/admin/runtime/api-keys`
- [Revoke a runtime API key](https://docs.spacerun.co/docs/platform/reference/runtime-api-keys/revokeRuntimeApiKey.md): `POST /v1/admin/runtime/api-keys/{id}/revoke`

## Runtime apps

See the [workflow guide](/docs/platform/guides/runtime-management) for prerequisites and examples.

- [List runtime apps](https://docs.spacerun.co/docs/platform/reference/runtime-apps/listRuntimeApps.md): `GET /v1/admin/runtime/apps`
- [Create a runtime app](https://docs.spacerun.co/docs/platform/reference/runtime-apps/createRuntimeApp.md): `POST /v1/admin/runtime/apps`
- [Delete a runtime app](https://docs.spacerun.co/docs/platform/reference/runtime-apps/deleteRuntimeApp.md): `DELETE /v1/admin/runtime/apps/{id}`
- [Update a runtime app](https://docs.spacerun.co/docs/platform/reference/runtime-apps/updateRuntimeApp.md): `PATCH /v1/admin/runtime/apps/{id}`

## Runtime pools and nodes

See the [workflow guide](/docs/platform/guides/runtime-management) for prerequisites and examples.

- [List runtime nodes](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/listRuntimeNodes.md): `GET /v1/admin/runtime/nodes`
- [Delete a node](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/deleteRuntimeNode.md): `DELETE /v1/admin/runtime/nodes/{id}`
- [Drain a node](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/drainRuntimeNode.md): `POST /v1/admin/runtime/nodes/{id}/drain`
- [Pull an image onto a node](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/pullRuntimeNodeImage.md): `POST /v1/admin/runtime/nodes/{id}/pull-image`
- [Undrain a node](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/undrainRuntimeNode.md): `POST /v1/admin/runtime/nodes/{id}/undrain`
- [List runtime pools](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/listRuntimePools.md): `GET /v1/admin/runtime/pools`
- [Create a pool](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/createRuntimePool.md): `POST /v1/admin/runtime/pools`
- [Delete a pool](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/deleteRuntimePool.md): `DELETE /v1/admin/runtime/pools/{id}`
- [Update a pool](https://docs.spacerun.co/docs/platform/reference/runtime-pools-and-nodes/updateRuntimePool.md): `PATCH /v1/admin/runtime/pools/{id}`

## Runtime sessions

See the [workflow guide](/docs/platform/guides/runtime-management) for prerequisites and examples.

- [Get a pool's session queue](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/getRuntimeQueue.md): `GET /v1/admin/runtime/queue`
- [List runtime sessions](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/listRuntimeSessions.md): `GET /v1/admin/runtime/sessions`
- [Get a session event timeline](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/listRuntimeSessionEvents.md): `GET /v1/admin/runtime/sessions/{id}/events`
- [Remove a member from a session](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/kickRuntimeSessionMember.md): `DELETE /v1/admin/runtime/sessions/{id}/members/{memberId}`
- [Change a queued session's priority](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/setRuntimeSessionPriority.md): `PATCH /v1/admin/runtime/sessions/{id}/priority`
- [Stop a runtime session](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/stopRuntimeSession.md): `POST /v1/admin/runtime/sessions/{id}/stop`
- [List a user's runtime sessions](https://docs.spacerun.co/docs/platform/reference/runtime-sessions/listRuntimeUserSessions.md): `GET /v1/admin/runtime/users/{userId}/sessions`

## Runtime webhooks

See the [workflow guide](/docs/platform/guides/runtime-management) for prerequisites and examples.

- [List runtime webhooks](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/listRuntimeWebhooks.md): `GET /v1/admin/runtime/webhooks`
- [Create a runtime webhook](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/createRuntimeWebhook.md): `POST /v1/admin/runtime/webhooks`
- [Delete a runtime webhook](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/deleteRuntimeWebhook.md): `DELETE /v1/admin/runtime/webhooks/{id}`
- [Update a runtime webhook](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/updateRuntimeWebhook.md): `PATCH /v1/admin/runtime/webhooks/{id}`
- [List webhook deliveries](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/listRuntimeWebhookDeliveries.md): `GET /v1/admin/runtime/webhooks/{id}/deliveries`
- [Redeliver a webhook delivery](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/redeliverRuntimeWebhook.md): `POST /v1/admin/runtime/webhooks/{id}/deliveries/{deliveryId}/redeliver`
- [Send a test event to a webhook](https://docs.spacerun.co/docs/platform/reference/runtime-webhooks/testRuntimeWebhook.md): `POST /v1/admin/runtime/webhooks/{id}/test`

## Site navigation

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List navigation items](https://docs.spacerun.co/docs/platform/reference/site-navigation/listSiteNavigation.md): `GET /v1/admin/site/navigation`
- [Create or update a navigation item](https://docs.spacerun.co/docs/platform/reference/site-navigation/upsertSiteNavItem.md): `PUT /v1/admin/site/navigation`
- [Delete a navigation item](https://docs.spacerun.co/docs/platform/reference/site-navigation/deleteSiteNavItem.md): `DELETE /v1/admin/site/navigation/{id}`

## Site pages

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List site pages](https://docs.spacerun.co/docs/platform/reference/site-pages/listSitePages.md): `GET /v1/admin/site/pages`
- [Create or update a page](https://docs.spacerun.co/docs/platform/reference/site-pages/upsertSitePage.md): `PUT /v1/admin/site/pages`
- [Get a page with its versions](https://docs.spacerun.co/docs/platform/reference/site-pages/getSitePage.md): `GET /v1/admin/site/pages/{id}`
- [Publish a page version](https://docs.spacerun.co/docs/platform/reference/site-pages/publishSitePageVersion.md): `POST /v1/admin/site/pages/{id}/publish`
- [Save a new page version](https://docs.spacerun.co/docs/platform/reference/site-pages/saveSitePageVersion.md): `POST /v1/admin/site/pages/{id}/versions`

## Site settings

See the [workflow guide](/docs/platform/guides/site-publishing) for prerequisites and examples.

- [List site settings sections](https://docs.spacerun.co/docs/platform/reference/site-settings/listSiteSettings.md): `GET /v1/admin/site/settings`
- [Get a settings section](https://docs.spacerun.co/docs/platform/reference/site-settings/getSiteSettingsSection.md): `GET /v1/admin/site/settings/{section}`
- [Save a settings section draft](https://docs.spacerun.co/docs/platform/reference/site-settings/saveSiteSettingsDraft.md): `PUT /v1/admin/site/settings/{section}`
- [Publish a settings section](https://docs.spacerun.co/docs/platform/reference/site-settings/publishSiteSettingsSection.md): `POST /v1/admin/site/settings/{section}/publish`
- [Roll back a settings section to a previous version](https://docs.spacerun.co/docs/platform/reference/site-settings/rollbackSiteSettingsSection.md): `POST /v1/admin/site/settings/{section}/rollback`
- [List published versions of a settings section](https://docs.spacerun.co/docs/platform/reference/site-settings/listSiteSettingsVersions.md): `GET /v1/admin/site/settings/{section}/versions`

## Stats

See the [workflow guide](/docs/platform/guides/operations-and-audit) for prerequisites and examples.

- [Signup-week retention cohorts](https://docs.spacerun.co/docs/platform/reference/stats/getStatsCohorts.md): `GET /v1/admin/stats/cohorts`
- [Tier and login-provider distribution](https://docs.spacerun.co/docs/platform/reference/stats/getStatsDistribution.md): `GET /v1/admin/stats/distribution`
- [Waitlist-to-paid funnel](https://docs.spacerun.co/docs/platform/reference/stats/getStatsFunnel.md): `GET /v1/admin/stats/funnel`
- [Live counters and latest revenue](https://docs.spacerun.co/docs/platform/reference/stats/getStatsOverview.md): `GET /v1/admin/stats/overview`
- [Daily signups, revenue and credits](https://docs.spacerun.co/docs/platform/reference/stats/getStatsTimeseries.md): `GET /v1/admin/stats/timeseries`
- [Per-user stats](https://docs.spacerun.co/docs/platform/reference/stats/getStatsUser.md): `GET /v1/admin/stats/users/{id}`

## Storage

See the [workflow guide](/docs/platform/guides/uploads-and-media) for prerequisites and examples.

- [List storage buckets with usage](https://docs.spacerun.co/docs/platform/reference/storage/listStorageBuckets.md): `GET /v1/admin/storage/buckets`
- [Browse bucket objects](https://docs.spacerun.co/docs/platform/reference/storage/browseStorageObjects.md): `GET /v1/admin/storage/buckets/{bucket}/objects`
- [Delete objects (reference-guarded)](https://docs.spacerun.co/docs/platform/reference/storage/deleteStorageObjects.md): `POST /v1/admin/storage/buckets/{bucket}/objects/delete`
- [Move or rename an object](https://docs.spacerun.co/docs/platform/reference/storage/moveStorageObject.md): `POST /v1/admin/storage/buckets/{bucket}/objects/move`
- [Get a signed preview URL for an object](https://docs.spacerun.co/docs/platform/reference/storage/previewStorageObject.md): `GET /v1/admin/storage/buckets/{bucket}/objects/preview`
- [Issue a signed upload URL to replace an object](https://docs.spacerun.co/docs/platform/reference/storage/replaceStorageObjectUrl.md): `POST /v1/admin/storage/buckets/{bucket}/objects/replace`
- [Issue a signed upload URL for a new object](https://docs.spacerun.co/docs/platform/reference/storage/createStorageUploadUrl.md): `POST /v1/admin/storage/buckets/{bucket}/objects/upload`
- [List unreferenced objects](https://docs.spacerun.co/docs/platform/reference/storage/listStorageOrphans.md): `GET /v1/admin/storage/buckets/{bucket}/orphans`
- [Update bucket limits](https://docs.spacerun.co/docs/platform/reference/storage/updateStorageBucketSettings.md): `PATCH /v1/admin/storage/buckets/{bucket}/settings`

## Store availability

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [List where a game is available](https://docs.spacerun.co/docs/platform/reference/store-availability/listStoreGameAvailability.md): `GET /v1/admin/store/games/{gameId}/availability`
- [Create or update a game's store listing](https://docs.spacerun.co/docs/platform/reference/store-availability/upsertStoreGameAvailability.md): `PUT /v1/admin/store/games/{gameId}/availability`
- [Remove a game's store listing](https://docs.spacerun.co/docs/platform/reference/store-availability/deleteStoreGameAvailability.md): `DELETE /v1/admin/store/games/{gameId}/availability/{storeId}`

## Store game art

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [Upload or replace a game art slot](https://docs.spacerun.co/docs/platform/reference/store-game-art/putStoreGameMedia.md): `PUT /v1/admin/store/games/{id}/media/{kind}`
- [Remove a game art slot](https://docs.spacerun.co/docs/platform/reference/store-game-art/deleteStoreGameMedia.md): `DELETE /v1/admin/store/games/{id}/media/{kind}`
- [Add a game screenshot](https://docs.spacerun.co/docs/platform/reference/store-game-art/addStoreGameScreenshot.md): `POST /v1/admin/store/games/{id}/screenshots`
- [Replace a game screenshot image](https://docs.spacerun.co/docs/platform/reference/store-game-art/replaceStoreGameScreenshot.md): `PUT /v1/admin/store/games/{id}/screenshots/{shotId}`
- [Delete a game screenshot](https://docs.spacerun.co/docs/platform/reference/store-game-art/deleteStoreGameScreenshot.md): `DELETE /v1/admin/store/games/{id}/screenshots/{shotId}`

## Store games

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [List store games](https://docs.spacerun.co/docs/platform/reference/store-games/listStoreGames.md): `GET /v1/admin/store/games`
- [Create a game](https://docs.spacerun.co/docs/platform/reference/store-games/createStoreGame.md): `POST /v1/admin/store/games`
- [Get a game with art and runtime apps](https://docs.spacerun.co/docs/platform/reference/store-games/getStoreGame.md): `GET /v1/admin/store/games/{id}`
- [Delete a game](https://docs.spacerun.co/docs/platform/reference/store-games/deleteStoreGame.md): `DELETE /v1/admin/store/games/{id}`
- [Update a game](https://docs.spacerun.co/docs/platform/reference/store-games/updateStoreGame.md): `PATCH /v1/admin/store/games/{id}`
- [Change a game's publication status](https://docs.spacerun.co/docs/platform/reference/store-games/setStoreGameStatus.md): `PATCH /v1/admin/store/games/{id}/status`

## Store lookups

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [List a lookup table](https://docs.spacerun.co/docs/platform/reference/store-lookups/listStoreLookup.md): `GET /v1/admin/store/lookups/{table}`
- [Create or update a lookup row](https://docs.spacerun.co/docs/platform/reference/store-lookups/upsertStoreLookup.md): `POST /v1/admin/store/lookups/{table}`
- [Delete a lookup row](https://docs.spacerun.co/docs/platform/reference/store-lookups/deleteStoreLookup.md): `DELETE /v1/admin/store/lookups/{table}/{key}`

## Store ratings

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [Get a game's rating summary](https://docs.spacerun.co/docs/platform/reference/store-ratings/getStoreGameRatings.md): `GET /v1/admin/store/games/{gameId}/ratings`
- [List games with rating totals](https://docs.spacerun.co/docs/platform/reference/store-ratings/listStoreRatedGames.md): `GET /v1/admin/store/ratings`

## Store runtime apps

See the [workflow guide](/docs/platform/guides/store-publishing) for prerequisites and examples.

- [List a game's runtime app mappings](https://docs.spacerun.co/docs/platform/reference/store-runtime-apps/listStoreGameRuntimeApps.md): `GET /v1/admin/store/games/{gameId}/runtime-apps`
- [Replace a game's runtime app mappings](https://docs.spacerun.co/docs/platform/reference/store-runtime-apps/replaceStoreGameRuntimeApps.md): `PUT /v1/admin/store/games/{gameId}/runtime-apps`
- [Add or update one runtime app mapping](https://docs.spacerun.co/docs/platform/reference/store-runtime-apps/saveStoreGameRuntimeApp.md): `POST /v1/admin/store/games/{gameId}/runtime-apps`
- [Remove a runtime app mapping](https://docs.spacerun.co/docs/platform/reference/store-runtime-apps/deleteStoreGameRuntimeApp.md): `DELETE /v1/admin/store/games/{gameId}/runtime-apps/{id}`

## System

See the [workflow guide](/docs/platform/guides/operations-and-audit) for prerequisites and examples.

- [Get auth stack config](https://docs.spacerun.co/docs/platform/reference/system/getSystemConfig.md): `GET /v1/admin/system/config`
- [List scheduled jobs](https://docs.spacerun.co/docs/platform/reference/system/listSystemCronJobs.md): `GET /v1/admin/system/cron`
- [Enable or disable a scheduled job](https://docs.spacerun.co/docs/platform/reference/system/setSystemCronJobActive.md): `PATCH /v1/admin/system/cron/{id}`
- [Run a scheduled job now](https://docs.spacerun.co/docs/platform/reference/system/runSystemCronJob.md): `POST /v1/admin/system/cron/{id}/run`
- [Ping dependencies](https://docs.spacerun.co/docs/platform/reference/system/getSystemHealth.md): `GET /v1/admin/system/health`
- [Get integration status](https://docs.spacerun.co/docs/platform/reference/system/getSystemIntegrations.md): `GET /v1/admin/system/integrations`

## Users

See the [workflow guide](/docs/platform/guides/staff-permissions) for prerequisites and examples.

- [List users](https://docs.spacerun.co/docs/platform/reference/users/listAdminUsers.md): `GET /v1/admin/users`
- [Get a user](https://docs.spacerun.co/docs/platform/reference/users/getAdminUser.md): `GET /v1/admin/users/{id}`
- [Delete a user](https://docs.spacerun.co/docs/platform/reference/users/deleteAdminUser.md): `DELETE /v1/admin/users/{id}`
- [Reset a user's avatar](https://docs.spacerun.co/docs/platform/reference/users/resetAdminUserAvatar.md): `POST /v1/admin/users/{id}/avatar/reset`
- [Ban a user](https://docs.spacerun.co/docs/platform/reference/users/banAdminUser.md): `POST /v1/admin/users/{id}/ban`
- [Change a user's email](https://docs.spacerun.co/docs/platform/reference/users/changeAdminUserEmail.md): `POST /v1/admin/users/{id}/email`
- [Edit a user's profile](https://docs.spacerun.co/docs/platform/reference/users/updateAdminUserProfile.md): `PATCH /v1/admin/users/{id}/profile`
- [Generate a fresh magic link for a user](https://docs.spacerun.co/docs/platform/reference/users/resendAdminUserMagicLink.md): `POST /v1/admin/users/{id}/resend-magic-link`
- [Revoke all of a user's sessions](https://docs.spacerun.co/docs/platform/reference/users/revokeAdminUserSessions.md): `POST /v1/admin/users/{id}/sessions/revoke`
- [Unban a user](https://docs.spacerun.co/docs/platform/reference/users/unbanAdminUser.md): `POST /v1/admin/users/{id}/unban`
- [Export users as CSV](https://docs.spacerun.co/docs/platform/reference/users/exportAdminUsersCsv.md): `GET /v1/admin/users/export.csv`
- [Invite a user by email](https://docs.spacerun.co/docs/platform/reference/users/inviteAdminUser.md): `POST /v1/admin/users/invite`

## Users: bulk actions

See the [workflow guide](/docs/platform/guides/staff-permissions) for prerequisites and examples.

- [Ban many users](https://docs.spacerun.co/docs/platform/reference/users-bulk-actions/bulkBanAdminUsers.md): `POST /v1/admin/users/bulk/ban`
- [Grant or adjust credits for many users](https://docs.spacerun.co/docs/platform/reference/users-bulk-actions/bulkGrantAdminUserCredits.md): `POST /v1/admin/users/bulk/credits`
- [Grant or revoke a role for many users](https://docs.spacerun.co/docs/platform/reference/users-bulk-actions/bulkAssignAdminUserRoles.md): `POST /v1/admin/users/bulk/roles`

## Users: detail tabs

See the [workflow guide](/docs/platform/guides/staff-permissions) for prerequisites and examples.

- [List a user's achievements](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserAchievements.md): `GET /v1/admin/users/{id}/achievements`
- [List emails sent to a user](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserEmails.md): `GET /v1/admin/users/{id}/emails`
- [List a user's friendships](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserFriends.md): `GET /v1/admin/users/{id}/friends`
- [List a user's game library](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserLibrary.md): `GET /v1/admin/users/{id}/library`
- [List a user's login history](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserLoginHistory.md): `GET /v1/admin/users/{id}/login-history`
- [List a user's in-app notifications](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserNotifications.md): `GET /v1/admin/users/{id}/notifications`
- [List a user's referrals](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserReferrals.md): `GET /v1/admin/users/{id}/referrals`
- [List a user's auth sessions and device authorizations](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/listAdminUserSessions.md): `GET /v1/admin/users/{id}/sessions`
- [Get a user's activity counters](https://docs.spacerun.co/docs/platform/reference/users-detail-tabs/getAdminUserStats.md): `GET /v1/admin/users/{id}/stats`
