Users

Users

Search users

GET /users/search

Request without providing basic authentication or access token will result empty email field for anti-spam purpose.

Parameters

Name	Type	Description
q	string	Required Keyword of username
limit	int	Limit number of search results. Default is 10

Example

$ curl https://try.gogs.io/api/v1/users/search?q=u&limit=5

Response

Status: 200 OK

{
  "data": [
    {
      "id": 1,
      "username": "unknwon",
      "full_name": "",
      "email": "fake@local",
      "avatar_url": "/avatars/1"
    },
    {
      "id": 4,
      "username": "user1",
      "full_name": "",
      "email": "[email protected]",
      "avatar_url": "/avatars/4"
    }
  ],
  "ok": true
}

Get a single user

GET /users/:username

Request without providing basic authentication or access token will result empty email field for anti-spam purpose.

Response

Status: 200 OK

{
  "id": 1,
  "username": "unknwon",
  "full_name": "",
  "email": "fake@local",
  "avatar_url": "/avatars/1"
}

Get the authenticated user

GET /user

Response

Status: 200 OK

{
  "id": 1,
  "username": "unknwon",
  "full_name": "",
  "email": "fake@local",
  "avatar_url": "/avatars/1"
}

List access tokens for a user

List access tokens requires that you are authenticated via basic authentication.

GET /users/:username/tokens

Response

Status: 200 OK

[
  {
    "name": "how are you?",
    "sha1": "91e52ff55460eeb247e6423c8ca6e770263cdd8d"
  },
  {
    "name": "hi",
    "sha1": "dd8b56a38a61dc6bb240f2b4fe78ec0eb3fc2a0b"
  }
]

Create a access token

Create a access token requires that you are authenticated via basic authentication.

POST /users/:username/tokens

Parameters

Name	Type	Description
name	string	Required Name of access token

Example

{
    "name": "gogs"
}

Response

Status: 201 Created

{
  "name": "gogs",
  "sha1": "61d40add61894c11b14049b5ab189dc8f0500aef"
}