get membership

Description

List all users authorized in your app. Private info can be returned by using Administrator token. Accreditation info is never returned.

URL

/VERSION/users.FORMAT

Available Format

JSON

HTTP Method

GET

Accepted Version

1

Require

Authorization or Administrator authorization.

Headers

Not applicable.

Parameters

  • access_token: (Required) access token. If Administrator token is provided, then emails and other private info can be returned.
  • count: (optional) number of elements in the page. Default is 100 users.
  • page: (optional) page of results requested. Default value is page 0.

Example

https://api.topoos.com/1/users.json?access_token=a8c39061-1b3f-468f-94ff-bcd8737e293d

Reply

JSON example reply when request success

[
{
        "id": "6fc41376-3046-21c7-8f9a-b5809d80f36e",
        "name": "johndoe",
        "email": null,
        "email_verified": false,
        "register": "2014-07-24T12:17:30.907+02:00",
        "provider": null,
        "profile": null,
        "ugroup": [],
        "accreditation": null
    },
    {
        "id": "e3b15d20-4e11-331e-a9f3-af77c1751f98",
        "name": "juanperez",
        "email": null,
        "email_verified": true,
        "register": "2014-04-23T13:50:38.857+02:00",
        "provider": "oauth",
        "profile": null,
        "ugroup": [],
        "accreditation": null
    }
]

JSON Response when request error is returned

{
    "code": 405,
    "description": "EXCEPTION_METHOD_NOT_ALLOWED"
}