Skip to content

Lists basic information for a user

GET
/api/users/{userId}

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Path Parameters

userId*
Typestring
Required
Pattern"[1-9]\\d*|current"

Responses

Success

application/json
JSON
{
"id": 342528,
"name": "Franzi",
"avatar": "/api/uploads/99d1fb45-9748-3510-ac02-87b46c40048c",
"isSleeping": true
}

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python