API Reference

Get leaderboard

This API is used to get leaderboard data from the specified event. It will return a list of leaderboard data like firstName, lastName, title, photo, point, userId, etc.

To call this API, the user has to pass query param with API urls like eventUrl and authentication key to authenticate the user.

Response

Here is the description of response attributes, which returns to the form of JSON.

AttributeDescription
firstName This contains the first name from the leaderboard. Only 50 Characters are allowed in firstName.
lastName This contains the last name from the leaderboard. Only 50 Characters are allowed in lastName.
photo This contains a photo of the leaderboard.
point This will return the number of points on the leaderboard.
title This contains the name of the title on the leaderboard.
userId This user ID represents the unique ID of each leaderboard.

Error Code

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
40600013Can't create url
4040200No Event could be found
Language
Authorization
Header
Click Try It! to start a request and see the response here!