Search for users
GET
/users/search
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “ Query Parameters ” q
string
Keyword
uid
integer format: int64
ID of the user to search for
sort
string
Sort order of results
page
integer
Page number of results to return (1-based)
limit
integer
Page size of results
Responses
Section titled “ Responses ”SearchResults of a successful search
Media type application/json
UserSearchResults
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 profile page
string
id
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
prohibit_login
Is user login prohibited
boolean
pronouns
The user’s pronouns
string
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
ok
boolean
Example
{ "data": [ { "login_name": "empty" } ]}