Skip to main content
bjoern_schulze
Helper ⭐️⭐️⭐️
Oct 9, 2026 10:12 PM UTC
Solved

API access to rank definitions and progression rules

I’m building a custom gamification widget for our community. It should show the signed-in member’s current rank, total points, next attainable rank, and progress towards that rank, including the needed points or other requirements (like “2 more solutions”).

I can retrieve the current rank through the Web SDK and total points through `GET /gamification/leaderboard/user/{id}?period=all_time`. However, I haven’t found a documented API for retrieving the complete rank configuration.

Is there a supported read-only API endpoint or export that provides:

  • Rank IDs and public display names
  • Rank priority/order
  • Minimum requirements, including points and activity thresholds
  • “Any of” / “All of” role restrictions

If available, which authentication, permissions, or additional product features are required? Also, does the “Minimum points earned” rank condition use the same total returned by the all-time leaderboard endpoint?

The goal is to keep the widget aligned with the configuration in Control without maintaining a duplicate set of rank rules manually.

revathimenon
Gainsight Community Lead
Oct 12, 2026 1:00 PM UTC

Hi ​@bjoern_schulze 

My team suggested that this can be achieved using a custom script.

  1. Retrieve user data: Use inSidedData.user to retrieve the signed-in member’s rank, roles, topics, replies, solved posts, and likes without requiring additional API calls or credentials.
  2. Configure rank rules manually: Document the rules and requirements configured for each rank. Since the rank configuration is not available through the API, we need to maintain the rank settings manually and build custom logic to determine the requirements for the next rank.
  3. Retrieve user points: Use JavaScript to retrieve the current user’s points from the .qa-user-points .qa-link-to-leaderboard class and display them in the widget.
  4. Build the custom widget: Develop the HTML, CSS, and JavaScript to calculate and display the user’s current rank, points, and progress toward the next rank based on the configured rules.
  5. Maintain the rank configuration: Whenever the rank rules or settings change in the community, the corresponding configuration in the custom code must also be updated to ensure the widget continues to display accurate progress and requirements.

Finally, add the code to a custom widget in the community to display the rank progress information in the same format as the reference image.

Please let me know if you run into any issues while trying it out!

Where focus goes, energy flows.

3 replies

jvdc
Expert ⭐️
Oct 12, 2026 9:34 AM UTC

Yeah I wanted to build the same thing, but did not find any API calls that would do it. I would suggest to submit this as an idea.

Translate
revathimenon
Gainsight Community Lead
Oct 12, 2026 10:48 AM UTC

Hi ​@bjoern_schulze 
There isn’t currently a supported, read-only endpoint or export for the full rank configuration. But there might be some workaround for this to some extent.

I’m checking with the team internally to see what’s possible here. Will loop back shortly

Translate
Where focus goes, energy flows.
revathimenon
Gainsight Community Lead
Oct 12, 2026 1:00 PM UTC

Hi ​@bjoern_schulze 

My team suggested that this can be achieved using a custom script.

  1. Retrieve user data: Use inSidedData.user to retrieve the signed-in member’s rank, roles, topics, replies, solved posts, and likes without requiring additional API calls or credentials.
  2. Configure rank rules manually: Document the rules and requirements configured for each rank. Since the rank configuration is not available through the API, we need to maintain the rank settings manually and build custom logic to determine the requirements for the next rank.
  3. Retrieve user points: Use JavaScript to retrieve the current user’s points from the .qa-user-points .qa-link-to-leaderboard class and display them in the widget.
  4. Build the custom widget: Develop the HTML, CSS, and JavaScript to calculate and display the user’s current rank, points, and progress toward the next rank based on the configured rules.
  5. Maintain the rank configuration: Whenever the rank rules or settings change in the community, the corresponding configuration in the custom code must also be updated to ensure the widget continues to display accurate progress and requirements.

Finally, add the code to a custom widget in the community to display the rank progress information in the same format as the reference image.

Please let me know if you run into any issues while trying it out!

Translate
Where focus goes, energy flows.