7501e34b98ae5da874e9aa99c4da37d16e1681bb
[mygpo.git] / doc / api / reference / user.rst
blob7501e34b98ae5da874e9aa99c4da37d16e1681bb
1 User API
2 ========
4 The User API can be used to retrieve public information about a user, and to
5 discover user-related resources.
8 Resources
9 ---------
11 The User API defines the following resources ::
13   /user/<username>
16 Get User Info
17 -------------
19 Request ::
21     GET /user/<username>
22     Content-Tpe: application/json
25 Response::
27     200 Found
28     Content-Tpe: application/json
30     {
31         "username": "stefan",
32         "avatar": "http://....",
33         "twitter": "@skoegl",
34         "description": "hi...",
35         "flattr_username": "stefankoegl",
37         "resources": {
38             "subscriptions": "http://api.gpodder.net/stefan/subscriptions",
39             ...
40         }
41     }