leaderboard API


Leaderboard API showcases the ranks and credits earned by all the users registered with the company. Based on the parameters entered in the Leaderboard URL, the security token is authenticated and returns all leaderboard details available in the Linchpin application.


Security token and origination url, should be sent as response headers for authentication

  • Once the Linchpin app is purchased, an interface will be provided to generate the security token which will be unique for a company.
  • Leaderboard API is authenticated based on the company token and external URL from where the request is sent.


The URL structure (path only, no root url)
api/v1/Leaderboard or / Leaderboard? filters={”minrange”:”1”,“maxrange”:”10”}


The request type

URL Params


Input parameter class structure

public class Filters
public int MinRange { get; set; } -- starting row number
public int MaxRange { get; set; } -- ending row number
public bool Active { get; set; } – Active/Inactive profiles

Input parameter Validation rules

Minimum value expected for MinRange is 1, Max Value should be greater than or equal to MinRange.

Response Codes

Output Response Object

public class LeaderboardDto { public string Name { get; set; } public string Email { get; set; } public string Profileimage { get; set; } public int Credits { get; set; } public int UserLevel { get; set; } public int NextLevelCredits { get; set; } public int Rank { get; set; } }

Success Response

Successful request: { “status”:200, "Leaderboard":[{ "Name":"Name", "Profileimage":"Profileimage", "Credits":"Credits", "UserLevel":"UserLevel", "NextLevelCredits":"NextLevelCredits", "Rank":"Rank" }, { "Name":"Name", "Profileimage":"Profileimage", "Credits":"Credits", "UserLevel":"UserLevel", "NextLevelCredits":"NextLevelCredits", "Rank":"Rank" }] }

HTTP Status Codes

Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. Example: Code: 200 OK Description: { Success } Code: 401 UNAUTHORIZED Description: {error: "Authentication credentials were missing or incorrect.”} Code: 400 Bad Request Description: { error : "The request was invalid or cannot be otherwise served" } Code: 404 Not Found Description: { error : "Leaderboard details not found" }