The User object
| Field | Type | Permission | Description |
|---|
| type | string | | Object type, set to user. |
| resource | string | | URL to the API resource |
| link | string | | URL to user on Flattr.com website |
| username | string | | Username on Flattr |
| url | string | | URL set by the user |
| firstname | string | | |
| lastname | string | | |
| avatar | string | | URL to a Flattr avatar, size: 48x48px |
| about | string | | Short description about the user |
| city | string | | |
| country | string | | |
| email | string | email, extendedread | |
| registered_at | int | extendedread | Format is unixtime |
The Mini User object
| Field | Type | Permission | Description |
|---|
| type | string | | Object type, set to user. |
| resource | string | | URL to the API resource |
| link | string | | URL to user on Flattr.com website |
| username | string | | Username on Flattr |
Get a user
Request
GET https://api.flattr.com/rest/v2/users/:username
Example response
{
"type": "user",
"resource": "https://api.flattr.com/rest/v2/users/flattr",
"link": "https://flattr.com/profile/flattr",
"username": "flattr",
"firstname": "Flattr.com",
"lastname": "",
"avatar": "",
"about": "This is the official Flattr account. We made this site :)",
"city": "",
"country": "",
"url": "http://flattr.com"
}
Errors
not_found (HTTP 404) - user does not exist
Get the authenticated user
Authorization needed
Request
GET https://api.flattr.com/rest/v2/user
Example response
{
"type": "user",
"resource": "https://api.flattr.com/rest/v2/users/flattr",
"link": "https://flattr.com/profile/flattr",
"username": "flattr",
"firstname": "Flattr.com",
"lastname": "",
"avatar": "",
"about": "This is the official Flattr account. We made this site :)",
"city": "",
"country": "",
"url": "http://flattr.com"
}
Errors
unauthorized (HTTP 401) - invalid credentials (bearer token) supplied
Response with scope extendedread
{
"type": "user",
"resource": "https://api.flattr.com/rest/v2/users/flattr",
"link": "https://flattr.com/profile/flattr",
"username": "flattr",
"firstname": "Flattr.com",
"lastname": "",
"avatar": "",
"about": "This is the official Flattr account. We made this site :)",
"city": "",
"country": "",
"url": "http://flattr.com",
"email": "info@flattr.com",
"registered_at": 1270166816
}