Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Return the status of a party.
Search
All
Pages
Start typing to search…
JUMP TO
Beamable API
How to Authenticate
Admin
/api/admin/inflight/failures
get
/api/admin/inflight/failures
del
Auth
Generate a new access token for a previously authenticated account. DEPRECATED: Use `tokens/refresh-token` instead.
post
Generate a new access token for a previously authenticated account.
post
Generate a new access token for a brand-new player.
post
Generate a new access token when given email and password credentials
post
Generate a new access token for a machine with a shared secret
post
/basic/auth/token/list
get
/basic/auth/token
get
/basic/auth/token
post
/basic/auth/token/revoke
put
Beamo
/api/beamo/manifests
post
/api/beamo/manifests
get
/api/beamo/manifests/{manifestId}
get
/api/beamo/manifests/current
get
/api/beamo/manifests/current
post
/api/beamo/manifests/promote
post
/api/beamo/templates
get
/api/beamo/status
get
/api/beamo/registry-uri
get
/api/beamo/services/registrations
post
/api/beamo/services/federation
post
/api/beamo/services/{serviceName}/federation/traffic
put
/api/beamo/services/{serviceName}/federation/traffic
del
/api/beamo/services/{serviceName}/metrics-request
post
/api/beamo/services/{serviceName}/logs/query
post
/api/beamo/services/logs/query/{queryId}
del
/api/beamo/services/logs/query/{queryId}
get
/api/beamo/services/secret
get
/api/beamo/storage/connection
get
/api/beamo/storage/{storageObjectName}/performance
get
/api/beamo/services/{serviceName}/logs/context
get
/api/beamo/services/{serviceName}/logs/context
put
/api/beamo/services/{serviceName}/logs/context
del
/api/beamo/services/logs/context
get
/basic/beamo/microservice/registrations
post
/basic/beamo/microservice/federation/traffic
put
/basic/beamo/microservice/federation/traffic
del
/basic/beamo/image/urls
post
/basic/beamo/metricsUrl
post
/basic/beamo/microservice/secret
get
/basic/beamo/queryLogs/result
post
/basic/beamo/storage/performance
get
/basic/beamo/manifests
get
/basic/beamo/templates
get
/basic/beamo/queryLogs
post
/basic/beamo/queryLogs
del
/basic/beamo/logsUrl
post
/basic/beamo/image/commit
put
/basic/beamo/uploadAPI
get
/basic/beamo/status
get
/basic/beamo/manifest/current
get
/basic/beamo/manifest/pull
post
/basic/beamo/registry
get
/basic/beamo/manifest/deploy
post
/basic/beamo/microservice/federation
post
/basic/beamo/storage/connection
get
/basic/beamo/manifest
get
/basic/beamo/manifest
post
BeamoOtel
/api/beamo/otel/views
get
/api/beamo/otel/views
post
/api/beamo/otel/views/{viewId}
del
/api/beamo/otel/views/{viewId}
put
/api/beamo/otel/auth/reader/config
get
/api/beamo/otel/auth/writer/config
get
Customer
/api/customers
post
/api/customers
get
/api/customers/verify
post
/api/customers/activate
put
/api/customers/{customerId}
get
/api/customers/{customerId}
put
/api/customers/{customerId}/admin-view
get
/api/customers/{customerId}/config
get
/api/customers/{customerId}/games
get
/api/customers/{customerId}/games
post
/api/customers/{customerId}/games/{gameId}
get
/api/customers/{customerId}/games/{gameId}
put
/api/customers/{customerId}/realms
post
/api/customers/{customerId}/realms/{realmId}
get
/api/customers/{customerId}/realms/{realmId}
del
/api/customers/{customerId}/realms/{realmId}
put
/api/customers/{customerId}/realms/{realmId}/rename
put
/api/customers/{customerId}/realms/{realmId}/config
get
/api/customers/{customerId}/realms/{realmId}/config
put
/api/customers/{customerId}/realms/{realmId}/config
patch
/api/customers/{customerId}/realms/{realmId}/client-defaults
get
/api/customers/{customerId}/realms/{destinationRealmId}/promotion
post
/api/customers/{customerId}/realms/{destinationRealmId}/promotion
get
/api/customers/aliases/{alias}
get
/api/customers/{customerId}/alias
put
Lobby
Query for active lobbies
get
Create a lobby. A leader is not necessary to create a lobby.
post
Exposes the internal "SetLobby" behavior as an Admin only endpoint
put
Get the current status of a lobby by id.
get
Join a lobby
put
Remove the requested player from the lobby. The host is able to remove anyone. Others may only remove themselves without error.
del
Join a lobby by passcode.
put
Update the properties of a lobby
put
Add the request tags to the requested player.
put
Remove the request tags from the requested player.
del
Invoke the Lobby actor to make the federated game server request.
post
Mailbox
/api/mailbox/publish
post
Party
Create a party for the current player.
post
Updates party state.
put
Return the status of a party.
get
Join a party
put
Promote a party member to leader.
put
Invite a player to a party
post
Cancel party invitation.
del
Remove the requested player from the party. The leader is able to remove anyone. Others may only remove themselves without error.
del
PlayerLobby
Fetch the requested player's lobby information
get
If the requested player is in a lobby, remove the player
del
PlayerParty
Fetch the requested player's party information
get
If the requested player is in a party, remove the player
del
Return list of party invites for player.
get
Return list of party invites for player.
get
PlayerTicket
Fetch the requested player's active Ticket information
get
Presence
/api/presence/query
post
Scheduler
Called by the Dispatcher lambda function to start a job execution at the appropriate time.
post
/api/scheduler/job
post
/api/internal/scheduler/job
post
/api/scheduler/jobs
get
/api/scheduler/jobs-paged
get
/api/scheduler/jobs/suspended
get
/api/scheduler/job/{jobId}
get
/api/scheduler/job/{jobId}
del
/api/scheduler/job/{jobId}/activity
get
/api/scheduler/job/{jobId}/activity-paged
get
/api/scheduler/jobs/activity-paged
get
/api/scheduler/job/{jobId}/next-executions
get
/api/scheduler/job/{jobId}/cancel
put
ServicePlan
/api/service-plans
get
/api/service-plans
post
/api/service-plans/{name}
get
/api/service-plans/{name}
del
Match
Fetch a match by ID.
get
Ticket
Query for active tickets
get
Create a ticket representing 1 or more players to be matched with others.
post
Fetch a ticket by ID.
get
Cancel a pending ticket. If no ticket with the id exists, this will still return a 204.
del
PlayerPresence
/api/players/{playerId}/presence
put
/api/players/{playerId}/presence
get
/api/players/{playerId}/presence/status
put
Content
/basic/content/manifests/unarchive
post
/basic/content/manifest/pull
post
/basic/content/manifest/history
get
/basic/content/binary
post
/basic/content/manifests/pull
post
/basic/content/content
get
/basic/content/localizations
get
/basic/content/localizations
put
/basic/content/localizations
del
/basic/content/text
post
/basic/content/manifest/exact
get
/basic/content/manifest
get
/basic/content/manifest
post
/basic/content/manifest/diffs
get
/basic/content/manifests/archive
post
/basic/content/
post
/basic/content/manifest/public
get
/basic/content/manifest/public/json
get
/basic/content/manifest/repeat
put
/basic/content/manifest/private/json
get
/basic/content/manifest/private
get
/basic/content/manifest/checksums
get
/basic/content/manifest/checksum
get
/basic/content/manifests
get
Event-players
/object/event-players/{objectId}/
get
/object/event-players/{objectId}/claim
post
/object/event-players/{objectId}/score
put
Events
/basic/events/content
get
/basic/events/calendar
get
/basic/events/applyContent
post
/basic/events/running
get
/object/events/{objectId}/endPhase
put
/object/events/{objectId}/
get
/object/events/{objectId}/ping
get
/object/events/{objectId}/content
put
/object/events/{objectId}/content
del
/object/events/{objectId}/refresh
put
Group-users
/object/group-users/{objectId}/availability
get
/object/group-users/{objectId}/recommended
get
/object/group-users/{objectId}/join
post
/object/group-users/{objectId}/join
del
/object/group-users/{objectId}/group
post
/object/group-users/{objectId}/search
get
/object/group-users/{objectId}/
get
Groups
/object/groups/{objectId}/role
put
/object/groups/{objectId}/kick
post
/object/groups/{objectId}/apply
post
/object/groups/{objectId}/donations
post
/object/groups/{objectId}/donations
put
/object/groups/{objectId}/member
del
/object/groups/{objectId}/
get
/object/groups/{objectId}/
put
/object/groups/{objectId}/
del
/object/groups/{objectId}/donations/claim
put
/object/groups/{objectId}/invite
post
/object/groups/{objectId}/petition
post
Inventory
/basic/inventory/items
get
/basic/inventory/currency
get
/object/inventory/{objectId}/preview
put
/object/inventory/{objectId}/multipliers
get
/object/inventory/{objectId}/transaction
del
/object/inventory/{objectId}/
get
/object/inventory/{objectId}/
post
/object/inventory/{objectId}/
put
/object/inventory/{objectId}/proxy/reload
put
/object/inventory/{objectId}/transfer
put
Leaderboards
/basic/leaderboards/list
get
/basic/leaderboards/player
get
/basic/leaderboards/assignment
get
/basic/leaderboards/uid
get
/object/leaderboards/{objectId}/entries
del
/object/leaderboards/{objectId}/membership
get
/object/leaderboards/{objectId}/ranks
get
/object/leaderboards/{objectId}/partition
get
/object/leaderboards/{objectId}/friends
get
/object/leaderboards/{objectId}/
post
/object/leaderboards/{objectId}/
del
/object/leaderboards/{objectId}/matches
get
/object/leaderboards/{objectId}/assignment
get
/object/leaderboards/{objectId}/assignment
del
/object/leaderboards/{objectId}/entry
put
/object/leaderboards/{objectId}/entry
del
/object/leaderboards/{objectId}/freeze
put
/object/leaderboards/{objectId}/details
get
/object/leaderboards/{objectId}/view
get
/object/leaderboards/{objectId}/swap
put
Accounts
/basic/accounts/me/device
del
/basic/accounts/me
get
/basic/accounts/me
put
/basic/accounts/me/third-party
del
/basic/accounts/get-personally-identifiable-information
get
/basic/accounts/search
get
/basic/accounts/email-update/init
post
/basic/accounts/email-update/confirm
post
/basic/accounts/available/external_identity
get
/basic/accounts/available/third-party
get
/basic/accounts/admin/admin-user
post
/basic/accounts/register
post
/basic/accounts/admin/me
get
/basic/accounts/password-update/init
post
/basic/accounts/admin/admin-users
get
/basic/accounts/find
get
/basic/accounts/signup
post
/basic/accounts/available/device-id
get
/basic/accounts/available
get
/basic/accounts/password-update/confirm
post
/basic/accounts/external_identity
post
/basic/accounts/external_identity
del
/object/accounts/{objectId}/admin/email
put
/object/accounts/{objectId}/available-roles
get
/object/accounts/{objectId}/role/report
get
/object/accounts/{objectId}/role
put
/object/accounts/{objectId}/role
del
/object/accounts/{objectId}/admin/scope
put
/object/accounts/{objectId}/admin/scope
del
/object/accounts/{objectId}/admin/third-party
put
/object/accounts/{objectId}/admin/third-party
del
/object/accounts/{objectId}/
put
/object/accounts/{objectId}/admin/forget
del
Stats
/basic/stats/subscribe
put
/basic/stats/subscribe
del
/basic/stats/client/batch
get
/basic/stats/batch
post
/basic/stats/search
post
/basic/stats/search/extended
post
/object/stats/{objectId}/client/stringlist
post
/object/stats/{objectId}/
get
/object/stats/{objectId}/
post
/object/stats/{objectId}/
del
/object/stats/{objectId}/client
get
/object/stats/{objectId}/client
post
Tournaments
/basic/tournaments/search/groups
post
/basic/tournaments/
get
/basic/tournaments/
post
/basic/tournaments/me/group
get
/basic/tournaments/rewards
get
/basic/tournaments/rewards
post
/basic/tournaments/global
get
/basic/tournaments/standings/group
get
/basic/tournaments/standings
get
/basic/tournaments/admin/player
get
/basic/tournaments/admin/player
put
/basic/tournaments/me
get
/basic/tournaments/champions
get
/basic/tournaments/score
post
/basic/tournaments/groups
get
Cloudsaving
/basic/cloudsaving/data/replace
post
/basic/cloudsaving/data
del
/basic/cloudsaving/data/downloadURL
post
/basic/cloudsaving/data/downloadURLFromPortal
post
/basic/cloudsaving/data/move
put
/basic/cloudsaving/data/moveFromPortal
put
/basic/cloudsaving/data/uploadURLFromPortal
post
/basic/cloudsaving/data/commitManifest
put
/basic/cloudsaving/data/uploadURL
post
/basic/cloudsaving/
get
Payments
/basic/payments/windows/purchase/track
post
/basic/payments/audits
get
/basic/payments/windows/purchase/complete
post
/basic/payments/test/purchase/begin
post
/basic/payments/facebook/update
get
/basic/payments/facebook/update
post
/basic/payments/steam/purchase/fail
post
/basic/payments/facebook/purchase/complete
post
/basic/payments/facebook/purchase/fail
post
/basic/payments/test/purchase/complete
post
/basic/payments/itunes/product
get
/basic/payments/googleplay/purchase/complete
post
/basic/payments/test/purchase/track
post
/basic/payments/googleplay/purchase/begin
post
/basic/payments/itunes/purchase/begin
post
/basic/payments/googleplay/purchase/verify
post
/basic/payments/facebook/purchase/cancel
post
/basic/payments/coupon/purchase/track
post
/basic/payments/steam/purchase/complete
post
/basic/payments/facebook/purchase/track
post
/basic/payments/itunes/purchase/fail
post
/basic/payments/test/purchase/verify
post
/basic/payments/test/purchase/cancel
post
/basic/payments/googleplay/purchase/track
post
/basic/payments/steam/prices
get
/basic/payments/windows/purchase/verify
post
/basic/payments/test/purchase/fail
post
/basic/payments/coupon/purchase/cancel
post
/basic/payments/itunes/purchase/verify
post
/basic/payments/itunes/purchase/complete
post
/basic/payments/coupon/purchase/begin
post
/basic/payments/facebook/purchase/verify
post
/basic/payments/steam/purchase/track
post
/basic/payments/facebook/purchase/begin
post
/basic/payments/steam/order
get
/basic/payments/coupon/purchase/verify
post
/basic/payments/windows/purchase/begin
post
/basic/payments/windows/product
get
/basic/payments/googleplay/purchase/fail
post
/basic/payments/facebook/product
get
/basic/payments/googleplay/purchase/cancel
post
/basic/payments/coupon/product
get
/basic/payments/coupon/purchase/fail
post
/basic/payments/steam/purchase/begin
post
/basic/payments/steam/products
get
/basic/payments/steam/purchase/cancel
post
/basic/payments/steam/auth
post
/basic/payments/steam/product
get
/basic/payments/coupon/purchase/complete
post
/basic/payments/windows/purchase/cancel
post
/basic/payments/googleplay/product
get
/basic/payments/windows/purchase/fail
post
/basic/payments/itunes/purchase/cancel
post
/basic/payments/test/product
get
/basic/payments/steam/purchase/verify
post
/basic/payments/itunes/purchase/track
post
Push
/basic/push/register
post
/basic/push/send
post
Notification
/basic/notification/channel
post
/basic/notification/player
post
/basic/notification/custom
post
/basic/notification/server
post
/basic/notification/generic
post
/basic/notification/
get
/basic/notification/game
post
Realms
/basic/realms/customer/activate
get
/basic/realms/project/beamable
post
/basic/realms/customer/alias/available
get
/basic/realms/project
get
/basic/realms/project
post
/basic/realms/project
put
/basic/realms/project
del
/basic/realms/customer/verify
post
/basic/realms/games
get
/basic/realms/config
get
/basic/realms/config
post
/basic/realms/config
put
/basic/realms/project/rename
put
/basic/realms/plans
get
/basic/realms/plans
post
/basic/realms/client/defaults
get
/basic/realms/customer
get
/basic/realms/customer
post
/basic/realms/admin/inflight/failures
get
/basic/realms/admin/inflight/failures
del
/basic/realms/launch-message
get
/basic/realms/launch-message
post
/basic/realms/launch-message
del
/basic/realms/is-customer
get
/basic/realms/admin/customer
get
/basic/realms/game
get
/basic/realms/game
post
/basic/realms/game
put
/basic/realms/project/promote
get
/basic/realms/project/promote
post
/basic/realms/customers
get
/basic/realms/promotion
get
/basic/realms/promotion
post
Social
/basic/social/my
get
/basic/social/friends/invite
post
/basic/social/friends/invite
del
/basic/social/friends
del
/basic/social/friends/import
post
/basic/social/friends/make
post
/basic/social/
get
/basic/social/blocked
post
/basic/social/blocked
del
ChatV2
/object/chatV2/{objectId}/rooms
get
/object/chatV2/{objectId}/rooms
post
/object/chatV2/{objectId}/rooms
del
/object/chatV2/{objectId}/
get
/object/chatV2/{objectId}/messages
post
Commerce
/basic/commerce/catalog/legacy
post
/basic/commerce/catalog
get
/basic/commerce/skus
get
/basic/commerce/skus
post
/object/commerce/{objectId}/
get
/object/commerce/{objectId}/coupons/count
get
/object/commerce/{objectId}/listings/cooldown
put
/object/commerce/{objectId}/offersAdmin
get
/object/commerce/{objectId}/purchase
post
/object/commerce/{objectId}/purchase
put
/object/commerce/{objectId}/listings
get
/object/commerce/{objectId}/status
del
/object/commerce/{objectId}/coupons
post
/object/commerce/{objectId}/stats/update
post
/object/commerce/{objectId}/offers
get
Calendars
/object/calendars/{objectId}/claim
post
/object/calendars/{objectId}/
get
Announcements
/basic/announcements/list/tags
get
/basic/announcements/list
get
/basic/announcements/search
get
/basic/announcements/list/definitions
get
/basic/announcements/
post
/basic/announcements/
del
/basic/announcements/content
get
/object/announcements/{objectId}/read
put
/object/announcements/{objectId}/claim
post
/object/announcements/{objectId}/raw
get
/object/announcements/{objectId}/
get
/object/announcements/{objectId}/
del
Mail
/basic/mail/attachments
put
/basic/mail/template
get
/basic/mail/
get
/basic/mail/
put
/basic/mail/bulk
post
/object/mail/{objectId}/detail
get
/object/mail/{objectId}/categories
get
/object/mail/{objectId}/search
post
/object/mail/{objectId}/bulk
post
/object/mail/{objectId}/bulk
put
/object/mail/{objectId}/accept/many
put
/object/mail/{objectId}/
get
/object/mail/{objectId}/
post
/object/mail/{objectId}/
put
Session
/basic/session/heartbeat
post
/basic/session/history
get
/basic/session/status
get
/basic/session/client/history
get
/basic/session/
post
Trials
/basic/trials/admin/data
get
/basic/trials/data
post
/basic/trials/data
del
/basic/trials/pause
put
/basic/trials/schedule
put
/basic/trials/
get
/basic/trials/
post
/basic/trials/
del
/basic/trials/admin
get
/basic/trials/start
put
Powered by
Return the status of a party.
Ask AI
get
https://api.beamable.com/api/parties/
{id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer +1
Response
Click
Try It!
to start a request and see the response here!
