Develop

Challenges

Updated: Oct 14, 2026
Notice of feature support change
The Scoreboard app has been officially deprecated as of December 20th, 2024. This change will not break existing apps using the Challenges API.
This is a Platform SDK feature requiring Data Use Checkup
To use this feature, you must complete a Data Use Checkup (DUC). The DUC ensures that you comply with Developer Policies. It requires an administrator from your team to certify that your use of user data aligns with platform guidelines. During development, a DUC you submit is approved automatically and gives your app provisional access. Submitting the app for review or enabling higher release channel limits permanently ends automatic approval, but features you already have keep working while their review runs (see When to submit a DUC). Test users can call these features before DUC approval, except getting the logged-in user, which needs the User ID or User Profile grant.
Apps for children can't use Platform SDK features
If you self-certify your app as primarily for children under 13, you must avoid using Platform SDK features. This restriction ensures compliance with age-specific guidelines. To ensure compliance, the Data Use Checkup for your app is disabled.
Amplify social interactions in your application with Challenges. Challenges leverage Destinations and Group Presence to create shareable links that allow players to compete directly based on score. Sending Challenge notifications brings new fun to the games your players already love.
Players can repeatedly challenge strangers and get to know them through this interaction. These Challenges are also asynchronous, so players aren’t restricted to being online at the same time.
Challenges can be ranked by highest or lowest scores within a time period. Any application that uses Leaderboards gets Challenges for free.
See more about implementing Leaderboards in Platform Services to get started with Leaderboards and Challenges.
User Data Warning
Avoid using any personal identifying information.

Challenge Client APIs

Get Challenge

This method retrieves detailed information for a single challenge by providing the challenge ID.
Challenges.get()
If no error occurs, this method returns a challenge.

Get Challenges Entries

This method retrieves a list of entries for a specific challenge, with options to filter and limit the results.
Challenges.getEntries()
If no error occurs, this method returns a list of challenge entries.

Get Challenges Entries After a Given Rank

This method retrieves an array of challenge entries after a given rank.
Challenges.getEntriesAfterRank()
If no error occurs, this method returns a list of challenge entries.

Get Challenge Entries By Ids

This method retrieves an array of challenge entries based on the given ids.
Challenges.getEntriesByIds()
If no error occurs, this method returns a list of challenge entries.

Get More Challenge Entries

Use the following methods to check whether any of the GetEntries results above have additional pages of entries.
ChallengeEntryArray.hasNextPage() or ChallengeEntryArray.hasPreviousPage()
If additional entries exist, use the following methods to retrieve them.
ChallengeEntryArray.getNextPage() or ChallengeEntryArray.getPreviousPage()
If no error occurs, this method returns a list of challenge entries.

Join a Challenge

This method lets players join a challenge.
Challenges.join()
If no error occurs, this method returns the updated challenge.

Leave a Challenge

This method lets players leave a challenge.
Challenges.leave()
If no error occurs, this method returns the updated challenge.

Decline a Challenge Invite

This method declines a challenge invite.
Challenges.declineInvite()
If no error occurs, this method returns the updated challenge.

Get A List of Challenges In Your Application

This method retrieves a list of challenges in your application. By default, it returns only active challenges.
Challenges.getList()
View the reference for ChallengeOptions, which represents the options used to create and retrieve challenges.
This method also supports pagination through ChallengeEntryArray.getNextPage() and ChallengeEntryArray.getPreviousPage(). See more with “Get More Challenge Entries.”

Server to Server APIs

For details on challenge server-to-server APIs, see Challenges Server to Server APIs.