Forgejo API
GET/admin/users

Search and list users

Lists users matching the supplied account, login, two-factor authentication, sorting, and pagination filters. Use source_id, login_name, and is_2fa_enabled to narrow the results, and use sort, page, and limit to control ordering and pagination.

6 parameters
source_idintegeroptional
The integer identifier of the login source used to filter users.
login_namestringoptional
The login name to search for.
is_2fa_enabledbooleanoptional
Whether to include only users with two-factor authentication enabled or disabled.
sortstringoptional
The result order: oldest, newest, alphabetically, reversealphabetically, recentupdate, or leastupdate.
Allowed:oldestnewestalphabeticallyreversealphabeticallyrecentupdateleastupdate
pageintegeroptional
The 1-based page number of users to return.
limitintegeroptional
The number of users to include in the response.

2 status codes
200Returns an array of user objects matching the supplied filters, including account status, profile details, identifiers, login information, and activity timestamps.
activebooleanoptional
Is user active
avatar_urlstringoptional
URL to the user's avatar
createdstringoptional
descriptionstringoptional
the user's description
emailstringoptional
followers_countintegeroptional
user counts
following_countintegeroptional
full_namestringoptional
the user's full name
html_urlstringoptional
URL to the user's profile page
idintegeroptional
the user's id
is_adminbooleanoptional
Is the user an administrator
languagestringoptional
User locale
last_loginstringoptional
locationstringoptional
the user's location
loginstringoptional
the user's username
login_namestringoptional
the user's authentication sign-in name.
Default:empty
prohibit_loginbooleanoptional
Is user login prohibited
pronounsstringoptional
the user's pronouns
restrictedbooleanoptional
Is user restricted
source_idintegeroptional
The ID of the user's Authentication Source
starred_repos_countintegeroptional
visibilitystringoptional
User visibility level option: public, limited, private
websitestringoptional
the user's website
403Returned when the authenticated user is not permitted to search users.
messagestringoptional
urlstringoptional

Error handling

A 403 is returned when the authenticated user is not permitted to search users. sort must be one of oldest, newest, alphabetically, reversealphabetically, recentupdate, or leastupdate; source_id must be an integer when provided.