Skip to content

Get user by username​

GET
/users/@{username}

Authorizations​

Authorization
TypeHTTP (bearer)

Parameters​

Path Parameters

username*
Typestring
Required

Query Parameters

withAvatar
Typeboolean
defaultfalse
withBanner
Typeboolean
defaultfalse

Responses​

OK

application/json
JSON
{
"id": 0,
"avatar": {
"id": 0,
"uuid": "string",
"filename": "string",
"tumbhash": "string"
},
"banner": {
"id": 0,
"uuid": "string",
"filename": "string",
"tumbhash": "string"
},
"displayName": "string",
"username": "string",
"status": 0,
"statusUpdatedAt": 0,
"createdAt": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python