List Users

GET https://api.runningahead.com/rest/users

List users that have granted access to your application.

Parameters

Parameter Type Description
access_token string (required) OAuth 2.0 token for your application.
limit integer The number of users to be returned. Must be between 1 and 100, inclusive. If not specified, limit will be defaulted to 50.
offset integer 0-based index of the first user to be returned.

Response

Parameter Type Description
entries User[] An array of user objects.
numEntries integer The total number of user that have granted access to your application.

Example

Request

List 30 users starting at entry 60.

https://api.runningahead.com/rest/users?
access_token=G47MMtrbM8Si58igc5V1I6&
limit=30&
offset=60

Response

{
    "code": 0,
    "data":
    {
        "entries":
        [
            {
                "familyName": "Picard",
                "givenName": "Jean-Luc",
                "screenName": "Captain Picard",
                "token": "b3125512sg1fs5Oq3681gg"
            },
            {
                "familyName": "Riker",
                "givenName": "William",
                "screenName": "Commander McKool",
                "token": "1jXPaxsyoZrDqmS347FE1v"
            },
            {
                "familyName": "La Forge",
                "givenName": "Geordi",
                "screenName": "Rainbow Reader",
                "token": "T9w5n717R335j07C6M6Dkd"
            },
            {
                "screeName": "Q",
                "token": "up3J7P90yqqNsrn48mW81q"
            },
            {
                "familyName": "Crusher",
                "givenName": "Wesley",
                "screenName": "Whil Wheaton",
                "token": "88dRq3hNLR54OX7XvHx6qr"
            }
        ],
        "numEntries": 65
    }
}