For AI agents: visit https://beamable2.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Manual Beamable API Ask a Question Contact Us

Manual Beamable API Ask a Question

Manual Beamable API Ask a Question Contact Us Beamable.com

Beamable API

Welcome

Server REST API - Overview
Client C# API
Advanced API Usage
- Signed Requests

A:B Testing

A/B Testing - Overview
/basic/trials/admin/data
- getget
/basic/trials/data
- postpost
- deletedel
/basic/trials/pause
- putput
/basic/trials/schedule
- putput
/basic/trials/
/basic/trials/admin
- getget
/basic/trials/start
- putput

accounts basic

Accounts - Overview
/basic/accounts/me/device
- deletedel
/basic/accounts/me
- getget
- putput
/basic/accounts/get-personally-identifiable-information
- getget
/basic/accounts/me/third-party
- deletedel
/basic/accounts/get-personally-identifiable-information
- getget
/basic/accounts/search
- getget
/basic/accounts/email-update/init
- postpost
/basic/accounts/email-update/confirm
- postpost
/basic/accounts/available/third-party
- getget
/basic/accounts/admin/admin-user
- postpost
/basic/accounts/register
- postpost
/basic/accounts/admin/me
- getget
/basic/accounts/password-update/init
- postpost
/basic/accounts/admin/admin-users
- getget
/basic/accounts/find
- getget
/object/accounts/{objectId}/admin/email
- putput
/object/accounts/{objectId}/available-roles
- getget
/basic/accounts/available/device-id
- getget
/basic/accounts/available
- getget
/object/accounts/{objectId}/role
- putput
- deletedel
/basic/accounts/password-update/confirm
- postpost
/object/accounts/{objectId}/admin/scope
- putput
- deletedel
/object/accounts/{objectId}/admin/third-party
- putput
- deletedel
/object/accounts/{objectId}/admin/forget
- deletedel

Announcements

Accouncements - Overview
/basic/announcements/search
- getget
/basic/announcements/list
- getget
/basic/announcements/
- postpost
- deletedel
/object/announcements/{objectId}/read
- putput
/object/announcements/{objectId}/claim
- postpost
/object/announcements/{objectId}/raw
- getget
/object/announcements/{objectId}/
- getget
- deletedel

Authentication

Authentication - Overview
/basic/auth/token
- getget
- postpost

Calendars

Calendars - Overview
/object/calendars/{objectId}/claim
- postpost
/object/calendars/{objectId}/
- getget

Chat

Chat - Overview
/object/chatV2/{objectId}/rooms
/object/chatV2/{objectId}/
- getget
/object/chatV2/{objectId}/messages
- postpost

cloudsaving basic

Cloud Saving - Overview
/basic/cloudsaving/data/replace
- postpost
/basic/cloudsaving/data
- deletedel
/basic/cloudsaving/data/downloadURL
- postpost
/basic/cloudsaving/data/metadata
- getget
/basic/cloudsaving/data/move
- putput
/basic/cloudsaving/data/uploadURLFromPortal
- postpost
/basic/cloudsaving/data/commitManifest
- putput
/basic/cloudsaving/data/uploadURL
- postpost
/basic/cloudsaving/
- getget

Commerce

Commerce - Overview
/basic/commerce/catalog
- getget
/basic/commerce/skus
- getget
- postpost
/object/commerce/{objectId}/
- getget
/object/commerce/{objectId}/coupons/count
- getget
/object/commerce/{objectId}/offersAdmin
- getget
/object/commerce/{objectId}/purchase
- postpost
- putput
/object/commerce/{objectId}/listings
- getget
/object/commerce/{objectId}/status
- deletedel
/object/commerce/{objectId}/coupons
- postpost
/object/commerce/{objectId}/stats/update
- postpost
/object/commerce/{objectId}/offers
- getget

Content

Content - Overview
/basic/content/manifest/pull
- postpost
/basic/content/content
- getget
/basic/content/text
- postpost
/basic/content/manifest
- getget
- postpost
/basic/content/
- postpost
/basic/content/manifest/public
- getget
/basic/content/manifest/private
- getget
/basic/content/manifest/checksum
- getget

events basic

Events - Overview
/basic/events/content
- getget
/basic/events/calendar
- getget
/basic/events/applyContent
- postpost
/basic/events/running
- getget
/object/events/{objectId}/endPhase
- putput
/object/events/{objectId}/
- getget
/object/events/{objectId}/ping
- getget
/object/events/{objectId}/content
- putput
- deletedel
/object/events/{objectId}/refresh
- putput
/object/event-players/{objectId}/
- getget
/object/event-players/{objectId}/claim
- postpost
/object/event-players/{objectId}/score
- putput

Game Relay [Instance]

Game Relay - Overview
/object/gamerelay/{objectId}/sync
- postpost
/object/gamerelay/{objectId}/
- postpost
/object/gamerelay/{objectId}/results
- postpost

inventory basic

/object/inventory/{objectId}/preview
- putput
Inventory - Overview
/basic/inventory/items
- getget
/object/inventory/{objectId}/multipliers
- getget
/basic/inventory/currency
- getget
/object/inventory/{objectId}/transfer
- putput
/object/inventory/{objectId}/
- getget
- putput

leaderboards basic

Leaderboards - Overview
/basic/leaderboards/list
- getget
/basic/leaderboards/player
- getget
/basic/leaderboards/assignment
- getget
/basic/leaderboards/uid
- getget
/object/leaderboards/{objectId}/entries
- deletedel
/object/leaderboards/{objectId}/membership
- getget
/object/leaderboards/{objectId}/ranks
- getget
/object/leaderboards/{objectId}/partition
- getget
/object/leaderboards/{objectId}/
- postpost
- deletedel
/object/leaderboards/{objectId}/matches
- getget
/object/leaderboards/{objectId}/assignment
- deletedel
/object/leaderboards/{objectId}/entry
- putput
- deletedel
/object/leaderboards/{objectId}/freeze
- putput
/object/leaderboards/{objectId}/details
- getget
/object/leaderboards/{objectId}/view
- getget
/object/leaderboards/{objectId}/swap
- putput

Groups (i.e. Guilds, Clans)

Groups - Overview
/basic/groups/search
- getget
/object/groups/{objectId}/role
- putput
/object/groups/{objectId}/kick
- postpost
/object/groups/{objectId}/apply
- postpost
/object/groups/{objectId}/donations
- postpost
- putput
/object/groups/{objectId}/member
- deletedel
/object/groups/{objectId}/
/object/groups/{objectId}/invite
- postpost
/object/groups/{objectId}/petition
- postpost
/object/group-users/{objectId}/availability
- getget
/object/group-users/{objectId}/recommended
- getget
/object/group-users/{objectId}/join
- postpost
- deletedel
/object/group-users/{objectId}/group
- postpost
/object/group-users/{objectId}/search
- getget
/object/group-users/{objectId}/
- getget

Mail

Mail - Overview
/basic/mail/attachments
- putput
/object/mail/{objectId}/detail
- getget
/basic/mail/template
- getget
/object/mail/{objectId}/categories
- getget
/basic/mail/
- getget
- putput
/object/mail/{objectId}/search
- postpost
/basic/mail/bulk
- postpost
/object/mail/{objectId}/bulk
- postpost
- putput
/object/mail/{objectId}/accept/many
- putput
/object/mail/{objectId}/

Matchmaking [Player]

Matchmaking - Overview
/object/matchmaking/{objectId}/tick
- putput
/object/matchmaking/{objectId}/match

Payments

Payments - Overview
/object/payments/{objectId}/
- getget
/basic/payments/windows/purchase/track
- postpost
/basic/payments/audits
- getget
/basic/payments/windows/purchase/complete
- postpost
/basic/payments/test/purchase/begin
- postpost
/basic/payments/facebook/update
- getget
- postpost
/basic/payments/steam/purchase/fail
- postpost
/basic/payments/facebook/purchase/complete
- postpost
/basic/payments/facebook/purchase/fail
- postpost
/basic/payments/test/purchase/complete
- postpost
/basic/payments/itunes/product
- getget
/basic/payments/googleplay/purchase/complete
- postpost
/basic/payments/test/purchase/track
- postpost
/basic/payments/googleplay/purchase/begin
- postpost
/basic/payments/itunes/purchase/begin
- postpost
/basic/payments/facebook/purchase/cancel
- postpost
/basic/payments/coupon/purchase/track
- postpost
/basic/payments/steam/purchase/complete
- postpost
/basic/payments/facebook/purchase/track
- postpost
/basic/payments/itunes/purchase/fail
- postpost
/basic/payments/test/purchase/cancel
- postpost
/basic/payments/googleplay/purchase/track
- postpost
/basic/payments/steam/prices
- getget
/basic/payments/test/purchase/fail
- postpost
/basic/payments/coupon/purchase/cancel
- postpost
/basic/payments/itunes/purchase/complete
- postpost
/basic/payments/coupon/purchase/begin
- postpost
/basic/payments/steam/purchase/track
- postpost
/basic/payments/facebook/purchase/begin
- postpost
/basic/payments/steam/order
- getget
/basic/payments/windows/purchase/begin
- postpost
/basic/payments/windows/product
- getget
/basic/payments/googleplay/purchase/fail
- postpost
/basic/payments/facebook/product
- getget
/basic/payments/googleplay/purchase/cancel
- postpost
/basic/payments/coupon/product
- getget
/basic/payments/coupon/purchase/fail
- postpost
/basic/payments/steam/purchase/begin
- postpost
/basic/payments/steam/purchase/cancel
- postpost
/basic/payments/steam/auth
- postpost
/basic/payments/steam/product
- getget
/basic/payments/coupon/purchase/complete
- postpost
/basic/payments/windows/purchase/cancel
- postpost
/basic/payments/googleplay/product
- getget
/basic/payments/windows/purchase/fail
- postpost
/basic/payments/itunes/purchase/cancel
- postpost
/basic/payments/test/product
- getget
/basic/payments/itunes/purchase/track
- postpost

Push Notifications (i.e. APNS, FCM)

Push Notifications - Overview
/basic/push/register
- postpost
/basic/push/send
- postpost

realms basic

Realm Administration - Overview
/basic/realms/project/beamable
- postpost
/basic/realms/customer/alias/available
- getget
/basic/realms/project
/basic/realms/games
- getget
/basic/realms/config
- getget
- putput
/basic/realms/project/rename
- putput
/basic/realms/plans
- getget
- postpost
/basic/realms/customer
- getget
- postpost
/basic/realms/launch-message
/basic/realms/is-customer
- getget
/basic/realms/admin/customer
- getget
/basic/realms/game
/basic/realms/project/promote
- getget
- postpost
/basic/realms/customers
- getget
/basic/realms/promotion
- getget
- postpost

notification basic

Server Notifications - Overview
/basic/notification/
- getget
/basic/notification/channel
- postpost
/basic/notification/player
- postpost
/basic/notification/custom
- postpost
/basic/notification/server
- postpost
/basic/notification/generic
- postpost
/basic/notification/game
- postpost

session basic

Session - Overview
/basic/session/history
- getget
/basic/session/status
- getget
/basic/session/heartbeat
- postpost
/basic/session/
- postpost

Stats

Stats - Overview
/basic/stats/client/batch
- getget
/basic/stats/batch
- postpost
/basic/stats/search
- postpost
/basic/stats/subscribe
- putput
/object/stats/{objectId}/client/stringlist
- postpost
/object/stats/{objectId}/
/object/stats/{objectId}/client
- getget
- postpost

Tournaments

Tournaments - Overview
/basic/tournaments/
- getget
- postpost
/basic/tournaments/rewards
- getget
- postpost
/basic/tournaments/global
- getget
/basic/tournaments/standings
- getget
/basic/tournaments/admin/player
- getget
- putput
/basic/tournaments/me
- getget
/basic/tournaments/champions
- getget
/basic/tournaments/score
- postpost
/object/tournaments/{objectId}/
- getget

Social

Social - Overview
/basic/social/friends
- deletedel
/basic/social/my
- getget
/basic/social/friends/import
- postpost
/basic/social/blocked
- postpost
- deletedel

Legacy

/basic/legacy-timers/defs
- getget
/basic/legacy-promos/
- getget
- postpost
/basic/legacy-timers/
/basic/legacy-promos/codes
- getget
/basic/legacy-promos/claim
- postpost
/basic/legacy-entitlement-defs/
/basic/legacy-entitlement-defs/upload
- postpost
/basic/legacy-entitlement-defs/player
- getget
/basic/legacy-entitlement-defs/grant
- postpost
/basic/legacy-entitlement-defs/claim
- putput
/basic/legacy-entitlement-defs/revoke
- deletedel
/basic/legacy-cloud/campaigns/schedule
- putput
/basic/legacy-cloud/templates
/basic/legacy-cloud/campaigns
/basic/legacy-pvp-defs/file
- postpost
/basic/legacy-pvp-defs/
/basic/legacy-shards/accepting
- getget
/basic/legacy-shards/preferred
- getget
/basic/legacy-shards/

Analytics

/basic/history/apiaccess/url
- getget
/basic/history/query/url
- postpost
/basic/history/microservices
- getget
/basic/history/account/roles
- getget
/basic/history/events
- getget

Powered by

Leaderboards - Overview

Allow player to manage leaderboard

See left sidebar navigation for more info or Server REST API - Overview to go back.

Updated 9 months ago

/basic/leaderboards/list

Did this page help you?

Updated 9 months ago

/basic/leaderboards/list

Did this page help you?