Users Service

The Users service returns user data for the given user ID (aka uid). The uid is passed in as a URL path element while the API key is passed as a GET parameter.

URI

GET https://services.armorgames.com/services/rest/v1/users/{{ uid }}.json

Parameters

Name Description
api_key
(optional)
32 hexadecimal digits (UUID)
An access key is unique to each game.
username
(optional)
If set to 1 (or true), you may supply a username instead of a uid as part of the service call,
and it searches for and retrieves data based on username instead of uid.

Note

When an api_key is not provided or is invalid, only a subset of the user data will be returned which includes: uid, username and avatar. Also, if the user has played the game before, a new field plays_game will show up on the request, with a value of 0 or 1. The game must be a launchable game, such as an mmo, for the plays_game value to work.

Response

GET https://services.armorgames.com/services/rest/v1/users/c3323c76c063636c91d2e8cb8f4dfcaf.json
{
  "version": 1,
  "code": 200,
  "message": "OK",
  "payload": {
    "uid": "c3323c76c063636c91d2e8cb8f4dfcaf",
    "username": "test_user",
    "avatar": "http://armatars.armorgames.com/armatar_149_50.50_c.jpg",
    "gender": "Male",
    "created_on": "1335466318"
  }
}