Sign in
latestOpenAPI 3.0.0Private2026-08-1081731.5 KB

170261dc1673

UsersApps

Get User App Achievements

Gets a listing of achievements a user has unlocked for an app

Required Scopes:
-user.app_achievements.read
get/v2/users/{route_users_id}/apps/{apps_id}/achievements

Path parameters

route_users_idstring required

The unique user ID or "me"

apps_idstring required

The unique app ID or "me"

Query parameters

skipinteger

Skips a number of objects from the start of the list. Used for paging.

limitinteger

Limits the number of objects returned.

namestring

Filters the returned rows by the name of the achievement. The % (url encoded as %25) can be included in the string as a wildcard.

sortOnstring

Sorts the returned object by one or more parameters. Multiple values can be separated by a comma for sorting on multiple fields.

  • created_at - The timestamp when the achievement was created
  • name - The name of the achievement
  • status - The status of the achievement
descendingstring

Orders the results in descending order based on the sortOn specified. If there are multiple sortOns specified, multiple values can be separated by a comma for each corresponding sortOn.

Response

Success

achievement_identifierstring required

The string ID of the achievement

namestring required

The name of the achievement

descriptionobject

The description of the achievement

imagestring required

An image url associated with the achievement

iconobject required

An icon url associated with the achievement

status'hidden' | 'active' | 'deleted' required

The status of the achievement

  • hidden - Achievement is hidden, but can still be earned
  • active - Achievement is active
  • deleted - Achievement has been deleted
created_atstring date-time required

The timestamp when the achievement was created

unlocked_atstring date-time

The timestamp when the achievement was unlocked

Example response

{
  "created_at": "1970-04-20 07:10:00+00",
  "unlocked_at": "1970-04-20 07:10:00+00"
}