This documentation is for Unity SDK 1.x through 3.x. If you are using Unity SDK 4.x or above,
please visit our new documentation.
×
Jump to Content
Manual
Beamable API
Ask a Question
Contact Us
Manual
Beamable API
Ask a Question
v1.0.0
v2.0.0
Manual
Beamable API
Ask a Question
Contact Us
Beamable.com
Beamable API
Beamable.com
Mercury
Beamable API
get
All
Pages
Start typing to search…
JUMP TO
Welcome
Server REST API - Overview
Client C# API
Advanced API Usage
Signed Requests
A:B Testing
A/B Testing - Overview
/basic/trials/admin/data
get
get
/basic/trials/data
post
post
delete
del
/basic/trials/pause
put
put
/basic/trials/schedule
put
put
/basic/trials/
get
get
post
post
delete
del
/basic/trials/admin
get
get
/basic/trials/start
put
put
accounts basic
Accounts - Overview
/basic/accounts/me/device
delete
del
/basic/accounts/me
get
get
put
put
/basic/accounts/get-personally-identifiable-information
get
get
/basic/accounts/me/third-party
delete
del
/basic/accounts/get-personally-identifiable-information
get
get
/basic/accounts/search
get
get
/basic/accounts/email-update/init
post
post
/basic/accounts/email-update/confirm
post
post
/basic/accounts/available/third-party
get
get
/basic/accounts/admin/admin-user
post
post
/basic/accounts/register
post
post
/basic/accounts/admin/me
get
get
/basic/accounts/password-update/init
post
post
/basic/accounts/admin/admin-users
get
get
/basic/accounts/find
get
get
/object/accounts/{objectId}/admin/email
put
put
/object/accounts/{objectId}/available-roles
get
get
/basic/accounts/available/device-id
get
get
/basic/accounts/available
get
get
/object/accounts/{objectId}/role
put
put
delete
del
/basic/accounts/password-update/confirm
post
post
/object/accounts/{objectId}/admin/scope
put
put
delete
del
/object/accounts/{objectId}/admin/third-party
put
put
delete
del
/object/accounts/{objectId}/admin/forget
delete
del
Announcements
Accouncements - Overview
/basic/announcements/search
get
get
/basic/announcements/list
get
get
/basic/announcements/
post
post
delete
del
/object/announcements/{objectId}/read
put
put
/object/announcements/{objectId}/claim
post
post
/object/announcements/{objectId}/raw
get
get
/object/announcements/{objectId}/
get
get
delete
del
Authentication
Authentication - Overview
/basic/auth/token
get
get
post
post
Calendars
Calendars - Overview
/object/calendars/{objectId}/claim
post
post
/object/calendars/{objectId}/
get
get
Chat
Chat - Overview
/object/chatV2/{objectId}/rooms
get
get
post
post
delete
del
/object/chatV2/{objectId}/
get
get
/object/chatV2/{objectId}/messages
post
post
cloudsaving basic
Cloud Saving - Overview
/basic/cloudsaving/data/replace
post
post
/basic/cloudsaving/data
delete
del
/basic/cloudsaving/data/downloadURL
post
post
/basic/cloudsaving/data/metadata
get
get
/basic/cloudsaving/data/move
put
put
/basic/cloudsaving/data/uploadURLFromPortal
post
post
/basic/cloudsaving/data/commitManifest
put
put
/basic/cloudsaving/data/uploadURL
post
post
/basic/cloudsaving/
get
get
Commerce
Commerce - Overview
/basic/commerce/catalog
get
get
/basic/commerce/skus
get
get
post
post
/object/commerce/{objectId}/
get
get
/object/commerce/{objectId}/coupons/count
get
get
/object/commerce/{objectId}/offersAdmin
get
get
/object/commerce/{objectId}/purchase
post
post
put
put
/object/commerce/{objectId}/listings
get
get
/object/commerce/{objectId}/status
delete
del
/object/commerce/{objectId}/coupons
post
post
/object/commerce/{objectId}/stats/update
post
post
/object/commerce/{objectId}/offers
get
get
Content
Content - Overview
/basic/content/manifest/pull
post
post
/basic/content/content
get
get
/basic/content/text
post
post
/basic/content/manifest
get
get
post
post
/basic/content/
post
post
/basic/content/manifest/public
get
get
/basic/content/manifest/private
get
get
/basic/content/manifest/checksum
get
get
events basic
Events - Overview
/basic/events/content
get
get
/basic/events/calendar
get
get
/basic/events/applyContent
post
post
/basic/events/running
get
get
/object/events/{objectId}/endPhase
put
put
/object/events/{objectId}/
get
get
/object/events/{objectId}/ping
get
get
/object/events/{objectId}/content
put
put
delete
del
/object/events/{objectId}/refresh
put
put
/object/event-players/{objectId}/
get
get
/object/event-players/{objectId}/claim
post
post
/object/event-players/{objectId}/score
put
put
Game Relay [Instance]
Game Relay - Overview
/object/gamerelay/{objectId}/sync
post
post
/object/gamerelay/{objectId}/
post
post
/object/gamerelay/{objectId}/results
post
post
inventory basic
/object/inventory/{objectId}/preview
put
put
Inventory - Overview
/basic/inventory/items
get
get
/object/inventory/{objectId}/multipliers
get
get
/basic/inventory/currency
get
get
/object/inventory/{objectId}/transfer
put
put
/object/inventory/{objectId}/
get
get
put
put
leaderboards basic
Leaderboards - Overview
/basic/leaderboards/list
get
get
/basic/leaderboards/player
get
get
/basic/leaderboards/assignment
get
get
/basic/leaderboards/uid
get
get
/object/leaderboards/{objectId}/entries
delete
del
/object/leaderboards/{objectId}/membership
get
get
/object/leaderboards/{objectId}/ranks
get
get
/object/leaderboards/{objectId}/partition
get
get
/object/leaderboards/{objectId}/
post
post
delete
del
/object/leaderboards/{objectId}/matches
get
get
/object/leaderboards/{objectId}/assignment
delete
del
/object/leaderboards/{objectId}/entry
put
put
delete
del
/object/leaderboards/{objectId}/freeze
put
put
/object/leaderboards/{objectId}/details
get
get
/object/leaderboards/{objectId}/view
get
get
/object/leaderboards/{objectId}/swap
put
put
Groups (i.e. Guilds, Clans)
Groups - Overview
/basic/groups/search
get
get
/object/groups/{objectId}/role
put
put
/object/groups/{objectId}/kick
post
post
/object/groups/{objectId}/apply
post
post
/object/groups/{objectId}/donations
post
post
put
put
/object/groups/{objectId}/member
delete
del
/object/groups/{objectId}/
get
get
put
put
delete
del
/object/groups/{objectId}/invite
post
post
/object/groups/{objectId}/petition
post
post
/object/group-users/{objectId}/availability
get
get
/object/group-users/{objectId}/recommended
get
get
/object/group-users/{objectId}/join
post
post
delete
del
/object/group-users/{objectId}/group
post
post
/object/group-users/{objectId}/search
get
get
/object/group-users/{objectId}/
get
get
Mail
Mail - Overview
/basic/mail/attachments
put
put
/object/mail/{objectId}/detail
get
get
/basic/mail/template
get
get
/object/mail/{objectId}/categories
get
get
/basic/mail/
get
get
put
put
/object/mail/{objectId}/search
post
post
/basic/mail/bulk
post
post
/object/mail/{objectId}/bulk
post
post
put
put
/object/mail/{objectId}/accept/many
put
put
/object/mail/{objectId}/
get
get
post
post
put
put
Matchmaking [Player]
Matchmaking - Overview
/object/matchmaking/{objectId}/tick
put
put
/object/matchmaking/{objectId}/match
get
get
post
post
delete
del
Payments
Payments - Overview
/object/payments/{objectId}/
get
get
/basic/payments/windows/purchase/track
post
post
/basic/payments/audits
get
get
/basic/payments/windows/purchase/complete
post
post
/basic/payments/test/purchase/begin
post
post
/basic/payments/facebook/update
get
get
post
post
/basic/payments/steam/purchase/fail
post
post
/basic/payments/facebook/purchase/complete
post
post
/basic/payments/facebook/purchase/fail
post
post
/basic/payments/test/purchase/complete
post
post
/basic/payments/itunes/product
get
get
/basic/payments/googleplay/purchase/complete
post
post
/basic/payments/test/purchase/track
post
post
/basic/payments/googleplay/purchase/begin
post
post
/basic/payments/itunes/purchase/begin
post
post
/basic/payments/facebook/purchase/cancel
post
post
/basic/payments/coupon/purchase/track
post
post
/basic/payments/steam/purchase/complete
post
post
/basic/payments/facebook/purchase/track
post
post
/basic/payments/itunes/purchase/fail
post
post
/basic/payments/test/purchase/cancel
post
post
/basic/payments/googleplay/purchase/track
post
post
/basic/payments/steam/prices
get
get
/basic/payments/test/purchase/fail
post
post
/basic/payments/coupon/purchase/cancel
post
post
/basic/payments/itunes/purchase/complete
post
post
/basic/payments/coupon/purchase/begin
post
post
/basic/payments/steam/purchase/track
post
post
/basic/payments/facebook/purchase/begin
post
post
/basic/payments/steam/order
get
get
/basic/payments/windows/purchase/begin
post
post
/basic/payments/windows/product
get
get
/basic/payments/googleplay/purchase/fail
post
post
/basic/payments/facebook/product
get
get
/basic/payments/googleplay/purchase/cancel
post
post
/basic/payments/coupon/product
get
get
/basic/payments/coupon/purchase/fail
post
post
/basic/payments/steam/purchase/begin
post
post
/basic/payments/steam/purchase/cancel
post
post
/basic/payments/steam/auth
post
post
/basic/payments/steam/product
get
get
/basic/payments/coupon/purchase/complete
post
post
/basic/payments/windows/purchase/cancel
post
post
/basic/payments/googleplay/product
get
get
/basic/payments/windows/purchase/fail
post
post
/basic/payments/itunes/purchase/cancel
post
post
/basic/payments/test/product
get
get
/basic/payments/itunes/purchase/track
post
post
Push Notifications (i.e. APNS, FCM)
Push Notifications - Overview
/basic/push/register
post
post
/basic/push/send
post
post
realms basic
Realm Administration - Overview
/basic/realms/project/beamable
post
post
/basic/realms/customer/alias/available
get
get
/basic/realms/project
get
get
post
post
put
put
delete
del
/basic/realms/games
get
get
/basic/realms/config
get
get
put
put
/basic/realms/project/rename
put
put
/basic/realms/plans
get
get
post
post
/basic/realms/customer
get
get
post
post
/basic/realms/launch-message
get
get
post
post
delete
del
/basic/realms/is-customer
get
get
/basic/realms/admin/customer
get
get
/basic/realms/game
get
get
post
post
put
put
/basic/realms/project/promote
get
get
post
post
/basic/realms/customers
get
get
/basic/realms/promotion
get
get
post
post
notification basic
Server Notifications - Overview
/basic/notification/
get
get
/basic/notification/channel
post
post
/basic/notification/player
post
post
/basic/notification/custom
post
post
/basic/notification/server
post
post
/basic/notification/generic
post
post
/basic/notification/game
post
post
session basic
Session - Overview
/basic/session/history
get
get
/basic/session/status
get
get
/basic/session/heartbeat
post
post
/basic/session/
post
post
Stats
Stats - Overview
/basic/stats/client/batch
get
get
/basic/stats/batch
post
post
/basic/stats/search
post
post
/basic/stats/subscribe
put
put
/object/stats/{objectId}/client/stringlist
post
post
/object/stats/{objectId}/
get
get
post
post
delete
del
/object/stats/{objectId}/client
get
get
post
post
Tournaments
Tournaments - Overview
/basic/tournaments/
get
get
post
post
/basic/tournaments/rewards
get
get
post
post
/basic/tournaments/global
get
get
/basic/tournaments/standings
get
get
/basic/tournaments/admin/player
get
get
put
put
/basic/tournaments/me
get
get
/basic/tournaments/champions
get
get
/basic/tournaments/score
post
post
/object/tournaments/{objectId}/
get
get
Social
Social - Overview
/basic/social/friends
delete
del
/basic/social/my
get
get
/basic/social/friends/import
post
post
/basic/social/blocked
post
post
delete
del
Legacy
/basic/legacy-timers/defs
get
get
/basic/legacy-promos/
get
get
post
post
/basic/legacy-timers/
get
get
post
post
delete
del
/basic/legacy-promos/codes
get
get
/basic/legacy-promos/claim
post
post
/basic/legacy-entitlement-defs/
get
get
post
post
put
put
delete
del
/basic/legacy-entitlement-defs/upload
post
post
/basic/legacy-entitlement-defs/player
get
get
/basic/legacy-entitlement-defs/grant
post
post
/basic/legacy-entitlement-defs/claim
put
put
/basic/legacy-entitlement-defs/revoke
delete
del
/basic/legacy-cloud/campaigns/schedule
put
put
/basic/legacy-cloud/templates
get
get
post
post
delete
del
/basic/legacy-cloud/campaigns
get
get
post
post
delete
del
/basic/legacy-pvp-defs/file
post
post
/basic/legacy-pvp-defs/
get
get
put
put
delete
del
/basic/legacy-shards/accepting
get
get
/basic/legacy-shards/preferred
get
get
/basic/legacy-shards/
get
get
post
post
put
put
delete
del
Analytics
/basic/history/apiaccess/url
get
get
/basic/history/query/url
post
post
/basic/history/microservices
get
get
/basic/history/account/roles
get
get
/basic/history/events
get
get
get
Ask AI
get
https://api.beamable.com/object/events/
{objectId}
/
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header +1
Response
Click
Try It!
to start a request and see the response here!
