Skip to main content
GET
/
users
/
search
Search for users
curl --request GET \
  --url https://gogs.example.com/api/v1/users/search \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": 123,
      "username": "<string>",
      "login": "<string>",
      "full_name": "<string>",
      "email": "[email protected]",
      "avatar_url": "<string>"
    }
  ],
  "ok": true
}

Authorizations

Authorization
string
header
required

Personal access token. Use format: token {YOUR_ACCESS_TOKEN}

Query Parameters

q
string
required

Keyword of username

limit
integer
default:10

Max results

Response

200 - application/json

Success

data
object[]
ok
boolean