API reference

Every published Platform API operation, grouped by tag. Browse by topic, filter by method, or use the site search to find an endpoint.

Filter by HTTP method

245 of 245 endpoints

Device authorization 5

• GETList the caller's device authorizations/v1/me/device-authorizationsUser
• DELETERevoke a device authorization/v1/me/device-authorizations/{id}User
• POSTApprove, deny or inspect a device code/v1/me/device/approveUser
• POSTStart a device authorization/v1/public/device/codePublic
• POSTPoll for the device authorization result/v1/public/device/tokenPublic

Email unsubscribe 2

• GETUnsubscribe via link/v1/public/email/unsubscribePublic
• POSTUnsubscribe (RFC 8058 one-click)/v1/public/email/unsubscribePublic

Public site 3

• GETList the public product catalog/v1/public/productsPublic
• GETGet published site configuration/v1/public/sitePublic
• POSTJoin the waitlist/v1/public/waitlistPublic

Public store 2

• GETList published games/v1/public/store/gamesPublic
• GETGet a published game by slug/v1/public/store/games/{slug}Public

Account 2

• POSTRequest account deletion/v1/me/deleteUser
• POSTConfirm account deletion/v1/me/delete/confirmUser

Billing 5

• GETGet the caller's billing overview/v1/me/billingUser
• POSTStart a Stripe Checkout session/v1/me/billing/checkout-sessionUser
• GETList the caller's Stripe invoices/v1/me/billing/invoicesUser
• GETList the caller's credit ledger/v1/me/billing/ledgerUser
• POSTStart a Stripe billing portal session/v1/me/billing/portal-sessionUser

Game sessions 2

• POSTStart a game session/v1/me/sessionsUser
• POSTStop the caller's open sessions/v1/me/sessions/stopUser

Profile 8

• GETGet the caller's profile/v1/meUser
• PATCHUpdate the caller's profile/v1/meUser
• POSTConfirm an uploaded avatar/v1/me/avatar/confirmUser
• POSTGet a signed avatar upload URL/v1/me/avatar/upload-urlUser
• GETList the caller's permission keys/v1/me/permissionsUser
• GETGet realtime subscription credentials/v1/me/realtimeUser
• GETList the caller's login sessions/v1/me/sessionsUser
• DELETERevoke a login session/v1/me/sessions/{sessionId}User

Support 1

• POSTSend a support message/v1/me/supportUser

Announcements 3

• GETList announcements/v1/admin/site/announcementsStaff
• PUTCreate or update an announcement/v1/admin/site/announcementsStaff
• GETGet an announcement/v1/admin/site/announcements/{id}Staff

Audit log 2

• GETList audit events/v1/admin/auditStaff
• GETList audit filter facets/v1/admin/audit/facetsStaff

Billing coupons 6

• GETList coupons/v1/admin/billing/couponsStaff
• POSTCreate a coupon/v1/admin/billing/couponsStaff
• DELETEDelete a coupon/v1/admin/billing/coupons/{id}Staff
• GETList promotion codes/v1/admin/billing/promotion-codesStaff
• POSTCreate a promotion code/v1/admin/billing/promotion-codesStaff
• PATCHActivate or deactivate a promotion code/v1/admin/billing/promotion-codes/{id}Staff

Billing credits 5

• POSTGift a credit pack/v1/admin/billing/credits/gift-packStaff
• POSTGrant or adjust credits/v1/admin/billing/credits/grantStaff
• GETList giftable tiers/v1/admin/billing/giftable-tiersStaff
• GETList credit ledger/v1/admin/billing/ledgerStaff
• GETList a user's credit lots/v1/admin/billing/lotsStaff

Billing overview 2

• GETStripe dashboard deep link/v1/admin/billing/deep-link/{type}/{id}Staff
• GETBilling overview/v1/admin/billing/overviewStaff

Billing payments 3

• GETList invoices (Stripe invoices)/v1/admin/billing/invoicesStaff
• GETList payments (Stripe charges)/v1/admin/billing/paymentsStaff
• POSTRefund a payment/v1/admin/billing/payments/{id}/refundStaff

Billing subscriptions 3

• GETList subscriptions/v1/admin/billing/subscriptionsStaff
• POSTCancel a subscription/v1/admin/billing/subscriptions/{id}/cancelStaff
• POSTResume a subscription/v1/admin/billing/subscriptions/{id}/resumeStaff

Catalog: achievements 4

• GETList achievement definitions/v1/admin/catalog/achievementsStaff
• POSTCreate an achievement definition/v1/admin/catalog/achievementsStaff
• DELETEDelete an achievement definition/v1/admin/catalog/achievements/{id}Staff
• PATCHUpdate an achievement definition/v1/admin/catalog/achievements/{id}Staff

Catalog: referral rules 2

• GETGet referral reward rules/v1/admin/catalog/referral-rulesStaff
• PUTSet referral reward rules/v1/admin/catalog/referral-rulesStaff

Content blocks 4

• GETList content blocks/v1/admin/site/content-blocksStaff
• PUTCreate or update a content block draft/v1/admin/site/content-blocksStaff
• GETGet a content block/v1/admin/site/content-blocks/{id}Staff
• POSTChange a content block status/v1/admin/site/content-blocks/{id}/statusStaff

Email audiences 9

• GETList audiences/v1/admin/email/audiencesStaff
• POSTCreate an audience/v1/admin/email/audiencesStaff
• GETGet an audience/v1/admin/email/audiences/{id}Staff
• PUTUpdate an audience/v1/admin/email/audiences/{id}Staff
• DELETEDelete an audience/v1/admin/email/audiences/{id}Staff
• GETList audience members/v1/admin/email/audiences/{id}/membersStaff
• PUTReplace audience members/v1/admin/email/audiences/{id}/membersStaff
• DELETERemove an audience member/v1/admin/email/audiences/{id}/members/{memberId}Staff
• GETPreview audience size/v1/admin/email/audiences/{id}/preview-countStaff

Email campaigns 13

• GETList campaigns/v1/admin/email/campaignsStaff
• POSTCreate a campaign/v1/admin/email/campaignsStaff
• GETGet a campaign/v1/admin/email/campaigns/{id}Staff
• PUTUpdate a campaign/v1/admin/email/campaigns/{id}Staff
• DELETEDelete a campaign/v1/admin/email/campaigns/{id}Staff
• POSTCancel a campaign/v1/admin/email/campaigns/{id}/cancelStaff
• GETList campaign deliveries/v1/admin/email/campaigns/{id}/deliveriesStaff
• POSTLaunch a campaign/v1/admin/email/campaigns/{id}/launchStaff
• POSTPause a campaign/v1/admin/email/campaigns/{id}/pauseStaff
• GETGet campaign progress/v1/admin/email/campaigns/{id}/progressStaff
• POSTResume a campaign/v1/admin/email/campaigns/{id}/resumeStaff
• POSTSchedule a campaign/v1/admin/email/campaigns/{id}/scheduleStaff
• POSTSend a campaign test email/v1/admin/email/campaigns/{id}/testStaff

Email deliveries 1

• GETList email deliveries/v1/admin/email/deliveriesStaff

Email templates 11

• GETList email templates/v1/admin/email/templatesStaff
• POSTCreate an email template/v1/admin/email/templatesStaff
• GETGet an email template/v1/admin/email/templates/{key}Staff
• PUTUpdate email template metadata/v1/admin/email/templates/{key}Staff
• DELETEDelete an email template/v1/admin/email/templates/{key}Staff
• GETDiff two template versions/v1/admin/email/templates/{key}/diffStaff
• POSTSave a draft version/v1/admin/email/templates/{key}/draftStaff
• POSTRender a template preview/v1/admin/email/templates/{key}/previewStaff
• POSTPublish a template version/v1/admin/email/templates/{key}/publishStaff
• POSTRoll back to a template version/v1/admin/email/templates/{key}/rollbackStaff
• POSTSend a test email/v1/admin/email/templates/{key}/test-sendStaff

Feature flags 3

• GETList feature flags/v1/admin/site/flagsStaff
• PUTCreate or update a feature flag/v1/admin/site/flags/{key}Staff
• DELETEDelete a feature flag/v1/admin/site/flags/{key}Staff

Notifications 1

• POSTBroadcast an in-app notification and/or email/v1/admin/notifications/broadcastStaff

Operations 6

• GETList alert subscriptions/v1/admin/ops/alert-subscriptionsStaff
• PUTReplace alert subscriptions/v1/admin/ops/alert-subscriptionsStaff
• POSTSend a test alert email/v1/admin/ops/alerts/testStaff
• GETList incidents/v1/admin/ops/incidentsStaff
• POSTSet panic mode/v1/admin/ops/panicStaff
• GETGet operational status/v1/admin/ops/statusStaff

Plans and pricing 15

• PUTCreate or update a credit pack/v1/admin/plans/credit-packsStaff
• POSTCreate a Stripe price/v1/admin/plans/pricesStaff
• POSTArchive a Stripe price/v1/admin/plans/prices/archiveStaff
• GETList products/v1/admin/plans/productsStaff
• POSTCreate or update a product/v1/admin/plans/productsStaff
• GETGet a product/v1/admin/plans/products/{id}Staff
• GETList a product's Stripe prices/v1/admin/plans/products/{id}/pricesStaff
• PATCHUpdate a product's Stripe object/v1/admin/plans/products/{id}/stripeStaff
• POSTCreate a product in Stripe and link it/v1/admin/plans/products/stripeStaff
• GETList rulesets/v1/admin/plans/rulesetsStaff
• PUTCreate or update a ruleset/v1/admin/plans/rulesetsStaff
• GETList the Stripe catalog/v1/admin/plans/stripe-catalogStaff
• POSTMigrate subscribers to a new price/v1/admin/plans/subscribers/migrateStaff
• GETList tiers/v1/admin/plans/tiersStaff
• PUTCreate or update a tier/v1/admin/plans/tiersStaff

Roles 10

• GETList roles/v1/admin/rolesStaff
• POSTCreate a role/v1/admin/rolesStaff
• DELETEDelete a role/v1/admin/roles/{id}Staff
• PATCHUpdate a role/v1/admin/roles/{id}Staff
• GETList members of a role/v1/admin/roles/{id}/membersStaff
• PUTReplace a role's permissions/v1/admin/roles/{id}/permissionsStaff
• POSTGrant a role to a user/v1/admin/roles/assignStaff
• GETGet the role/permission matrix/v1/admin/roles/permissionsStaff
• POSTRevoke a role from a user/v1/admin/roles/revokeStaff
• GETList a user's current roles/v1/admin/roles/user/{userId}Staff

Runtime API keys 3

• GETList runtime API keys/v1/admin/runtime/api-keysStaff
• POSTCreate a runtime API key/v1/admin/runtime/api-keysStaff
• POSTRevoke a runtime API key/v1/admin/runtime/api-keys/{id}/revokeStaff

Runtime apps 4

• GETList runtime apps/v1/admin/runtime/appsStaff
• POSTCreate a runtime app/v1/admin/runtime/appsStaff
• DELETEDelete a runtime app/v1/admin/runtime/apps/{id}Staff
• PATCHUpdate a runtime app/v1/admin/runtime/apps/{id}Staff

Runtime pools and nodes 9

• GETList runtime nodes/v1/admin/runtime/nodesStaff
• DELETEDelete a node/v1/admin/runtime/nodes/{id}Staff
• POSTDrain a node/v1/admin/runtime/nodes/{id}/drainStaff
• POSTPull an image onto a node/v1/admin/runtime/nodes/{id}/pull-imageStaff
• POSTUndrain a node/v1/admin/runtime/nodes/{id}/undrainStaff
• GETList runtime pools/v1/admin/runtime/poolsStaff
• POSTCreate a pool/v1/admin/runtime/poolsStaff
• DELETEDelete a pool/v1/admin/runtime/pools/{id}Staff
• PATCHUpdate a pool/v1/admin/runtime/pools/{id}Staff

Runtime sessions 7

• GETGet a pool's session queue/v1/admin/runtime/queueStaff
• GETList runtime sessions/v1/admin/runtime/sessionsStaff
• GETGet a session event timeline/v1/admin/runtime/sessions/{id}/eventsStaff
• DELETERemove a member from a session/v1/admin/runtime/sessions/{id}/members/{memberId}Staff
• PATCHChange a queued session's priority/v1/admin/runtime/sessions/{id}/priorityStaff
• POSTStop a runtime session/v1/admin/runtime/sessions/{id}/stopStaff
• GETList a user's runtime sessions/v1/admin/runtime/users/{userId}/sessionsStaff

Runtime webhooks 7

• GETList runtime webhooks/v1/admin/runtime/webhooksStaff
• POSTCreate a runtime webhook/v1/admin/runtime/webhooksStaff
• DELETEDelete a runtime webhook/v1/admin/runtime/webhooks/{id}Staff
• PATCHUpdate a runtime webhook/v1/admin/runtime/webhooks/{id}Staff
• GETList webhook deliveries/v1/admin/runtime/webhooks/{id}/deliveriesStaff
• POSTRedeliver a webhook delivery/v1/admin/runtime/webhooks/{id}/deliveries/{deliveryId}/redeliverStaff
• POSTSend a test event to a webhook/v1/admin/runtime/webhooks/{id}/testStaff

Site navigation 3

• GETList navigation items/v1/admin/site/navigationStaff
• PUTCreate or update a navigation item/v1/admin/site/navigationStaff
• DELETEDelete a navigation item/v1/admin/site/navigation/{id}Staff

Site pages 5

• GETList site pages/v1/admin/site/pagesStaff
• PUTCreate or update a page/v1/admin/site/pagesStaff
• GETGet a page with its versions/v1/admin/site/pages/{id}Staff
• POSTPublish a page version/v1/admin/site/pages/{id}/publishStaff
• POSTSave a new page version/v1/admin/site/pages/{id}/versionsStaff

Site settings 6

• GETList site settings sections/v1/admin/site/settingsStaff
• GETGet a settings section/v1/admin/site/settings/{section}Staff
• PUTSave a settings section draft/v1/admin/site/settings/{section}Staff
• POSTPublish a settings section/v1/admin/site/settings/{section}/publishStaff
• POSTRoll back a settings section to a previous version/v1/admin/site/settings/{section}/rollbackStaff
• GETList published versions of a settings section/v1/admin/site/settings/{section}/versionsStaff

Stats 6

• GETSignup-week retention cohorts/v1/admin/stats/cohortsStaff
• GETTier and login-provider distribution/v1/admin/stats/distributionStaff
• GETWaitlist-to-paid funnel/v1/admin/stats/funnelStaff
• GETLive counters and latest revenue/v1/admin/stats/overviewStaff
• GETDaily signups, revenue and credits/v1/admin/stats/timeseriesStaff
• GETPer-user stats/v1/admin/stats/users/{id}Staff

Storage 9

• GETList storage buckets with usage/v1/admin/storage/bucketsStaff
• GETBrowse bucket objects/v1/admin/storage/buckets/{bucket}/objectsStaff
• POSTDelete objects (reference-guarded)/v1/admin/storage/buckets/{bucket}/objects/deleteStaff
• POSTMove or rename an object/v1/admin/storage/buckets/{bucket}/objects/moveStaff
• GETGet a signed preview URL for an object/v1/admin/storage/buckets/{bucket}/objects/previewStaff
• POSTIssue a signed upload URL to replace an object/v1/admin/storage/buckets/{bucket}/objects/replaceStaff
• POSTIssue a signed upload URL for a new object/v1/admin/storage/buckets/{bucket}/objects/uploadStaff
• GETList unreferenced objects/v1/admin/storage/buckets/{bucket}/orphansStaff
• PATCHUpdate bucket limits/v1/admin/storage/buckets/{bucket}/settingsStaff

Store availability 3

• GETList where a game is available/v1/admin/store/games/{gameId}/availabilityStaff
• PUTCreate or update a game's store listing/v1/admin/store/games/{gameId}/availabilityStaff
• DELETERemove a game's store listing/v1/admin/store/games/{gameId}/availability/{storeId}Staff

Store game art 5

• PUTUpload or replace a game art slot/v1/admin/store/games/{id}/media/{kind}Staff
• DELETERemove a game art slot/v1/admin/store/games/{id}/media/{kind}Staff
• POSTAdd a game screenshot/v1/admin/store/games/{id}/screenshotsStaff
• PUTReplace a game screenshot image/v1/admin/store/games/{id}/screenshots/{shotId}Staff
• DELETEDelete a game screenshot/v1/admin/store/games/{id}/screenshots/{shotId}Staff

Store games 6

• GETList store games/v1/admin/store/gamesStaff
• POSTCreate a game/v1/admin/store/gamesStaff
• GETGet a game with art and runtime apps/v1/admin/store/games/{id}Staff
• DELETEDelete a game/v1/admin/store/games/{id}Staff
• PATCHUpdate a game/v1/admin/store/games/{id}Staff
• PATCHChange a game's publication status/v1/admin/store/games/{id}/statusStaff

Store lookups 3

• GETList a lookup table/v1/admin/store/lookups/{table}Staff
• POSTCreate or update a lookup row/v1/admin/store/lookups/{table}Staff
• DELETEDelete a lookup row/v1/admin/store/lookups/{table}/{key}Staff

Store ratings 2

• GETGet a game's rating summary/v1/admin/store/games/{gameId}/ratingsStaff
• GETList games with rating totals/v1/admin/store/ratingsStaff

Store runtime apps 4

• GETList a game's runtime app mappings/v1/admin/store/games/{gameId}/runtime-appsStaff
• PUTReplace a game's runtime app mappings/v1/admin/store/games/{gameId}/runtime-appsStaff
• POSTAdd or update one runtime app mapping/v1/admin/store/games/{gameId}/runtime-appsStaff
• DELETERemove a runtime app mapping/v1/admin/store/games/{gameId}/runtime-apps/{id}Staff

System 6

• GETGet auth stack config/v1/admin/system/configStaff
• GETList scheduled jobs/v1/admin/system/cronStaff
• PATCHEnable or disable a scheduled job/v1/admin/system/cron/{id}Staff
• POSTRun a scheduled job now/v1/admin/system/cron/{id}/runStaff
• GETPing dependencies/v1/admin/system/healthStaff
• GETGet integration status/v1/admin/system/integrationsStaff

Users 12

• GETList users/v1/admin/usersStaff
• GETGet a user/v1/admin/users/{id}Staff
• DELETEDelete a user/v1/admin/users/{id}Staff
• POSTReset a user's avatar/v1/admin/users/{id}/avatar/resetStaff
• POSTBan a user/v1/admin/users/{id}/banStaff
• POSTChange a user's email/v1/admin/users/{id}/emailStaff
• PATCHEdit a user's profile/v1/admin/users/{id}/profileStaff
• POSTGenerate a fresh magic link for a user/v1/admin/users/{id}/resend-magic-linkStaff
• POSTRevoke all of a user's sessions/v1/admin/users/{id}/sessions/revokeStaff
• POSTUnban a user/v1/admin/users/{id}/unbanStaff
• GETExport users as CSV/v1/admin/users/export.csvStaff
• POSTInvite a user by email/v1/admin/users/inviteStaff

Users: bulk actions 3

• POSTBan many users/v1/admin/users/bulk/banStaff
• POSTGrant or adjust credits for many users/v1/admin/users/bulk/creditsStaff
• POSTGrant or revoke a role for many users/v1/admin/users/bulk/rolesStaff

Users: detail tabs 9

• GETList a user's achievements/v1/admin/users/{id}/achievementsStaff
• GETList emails sent to a user/v1/admin/users/{id}/emailsStaff
• GETList a user's friendships/v1/admin/users/{id}/friendsStaff
• GETList a user's game library/v1/admin/users/{id}/libraryStaff
• GETList a user's login history/v1/admin/users/{id}/login-historyStaff
• GETList a user's in-app notifications/v1/admin/users/{id}/notificationsStaff
• GETList a user's referrals/v1/admin/users/{id}/referralsStaff
• GETList a user's auth sessions and device authorizations/v1/admin/users/{id}/sessionsStaff
• GETGet a user's activity counters/v1/admin/users/{id}/statsStaff