Get a user by username

GET/users/{username}

Looks up a user by username and returns the public user shape (no private fields). Readable by anyone, including anonymous callers.

Request

Headers

Name	Type	Scopes
`Authorization`optional	`string`

Path parameters

Name	Type	Description
`username`required	`string`	The user's username.

Responses

Status	Body	Description
`200`	`SimpleUser`	The user.
`404`	`Error`	The requested resource does not exist (or is not visible to the caller).

Request

bash

curl -X GET \
  --url "https://opengist.example.com/api/users/{username}" \
  -H "Authorization: Bearer og_xxxxxxxx"

Response 200

json

{
  "id": 1,
  "login": "string",
  "username": "string",
  "avatar_url": "https://opengist.example/...",
  "type": "string",
  "created_at": "2024-01-01T00:00:00Z"
}