View
Learn how to inspect a user.
Endpoint
GET /api/v1/users/:user
Parameters
The following parameters are used to configure the endpoint:
Name | Description |
---|---|
user | name of user |
Permissions
COMING SOON!
Responses
Status Code | Description |
---|---|
200 | indicates the request has succeeded |
401 | indicates the user does not have proper permissions |
Sample
This section assumes you already know how to authenticate to the API.
To authenticate to the API, please review the authentication documentation.
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
}
Last modified February 1, 2021: fix(reference): fix broken links (#205) (6dc23bdb)