Search for users

GET

/users/search

const url = 'https://gitea.example.com/api/v1/users/search';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://gitea.example.com/api/v1/users/search \
  --header 'Authorization: Basic <credentials>'

Authorizations

Parameters

Query Parameters

string

Keyword

uid

integer format: int64

ID of the user to search for

page

integer

Page number of results to return (1-based)

limit

integer

Page size of results

Responses

200

SearchResults of a successful search

application/json

object

data

Array<object>

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

boolean

Example

{
  "data": [
    {
      "login_name": "empty"
    }
  ]
}