View

Learn how to inspect a user.

Endpoint

GET  /api/v1/users/:user

Parameters

The following parameters are used to configure the endpoint:

NameDescription
username of user

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
401indicates the user does not have proper permissions

Sample

Request

curl \
  -X GET \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/users/OctoKitty"

Response

{
  "id": 1,
  "name": "OctoKitty",
  "token": null,
  "favorites": ["github/octocat"],
  "active": true,
  "admin": false
}