Skip to content

API: Users

Simon Bartlett edited this page Feb 5, 2015 · 1 revision

Table of Contents

GET /users

Retrieve the list of users

Request

Available query string parameters:

Param Example Default Description
skip 100 0 Specifies the number of users to skip
take 100 500 Specifies the number of users to return (Max: 5000)
Example
GET /users
[
    {
        "id": "54b33a7a79deea2116f15c1b",
        "firstName": "bob",
        "lastName": "smith",
        "username": "bsmith",
        "displayName": "bob smith",
        "avatar": "a74b7ad4ae60e8189e06b572e78366de"
    },
    ...
]

GET /users/:user

Retrieve user information given its :user identifier

Example
Get /users/54b33a7a79deea2116f15c1b
{
    "id": "54b33a7a79deea2116f15c1b",
    "firstName": "bob",
    "lastName": "smith",
    "username": "bsmith",
    "displayName": "bob smith",
    "avatar": "a74b7ad4ae60e8189e06b572e78366de"
}