Find users via various criteria. This method returns up to 100 results per page.

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you’re looking for a list of popular users, you might try this query:

q=tom+repos:%3E42+followers:%3E1000

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

External Documentation

To learn more, visit the GitHub documentation.

​
Basic Parameters

ParameterDescription
QueryThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See “Searching users” for a detailed list of qualifiers.
Return All PagesAutomatically fetch all resources, page by page.

​
Advanced Parameters

ParameterDescription
OrderDetermines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
PagePage number of the results to fetch.
Per PageThe number of results per page (max 100).
SortSorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match.

​
Example Output

{
	"value": {
		"incomplete_results": false,
		"items": [
			{
				"avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
				"events_url": "https://api.github.com/users/mojombo/events{/privacy}",
				"followers_url": "https://api.github.com/users/mojombo/followers",
				"following_url": "https://api.github.com/users/mojombo/following{/other_user}",
				"gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
				"gravatar_id": "",
				"html_url": "https://github.com/mojombo",
				"id": 1,
				"login": "mojombo",
				"node_id": "MDQ6VXNlcjE=",
				"organizations_url": "https://api.github.com/users/mojombo/orgs",
				"received_events_url": "https://api.github.com/users/mojombo/received_events",
				"repos_url": "https://api.github.com/users/mojombo/repos",
				"score": 1,
				"site_admin": true,
				"starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
				"subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
				"type": "User",
				"url": "https://api.github.com/users/mojombo"
			}
		],
		"total_count": 12
	}
}

​
Workflow Library Example

Search Users with Github and Send Results Via Email

Preview this Workflow on desktop