---
title: "Search users"
method: GET
path: "/search/users"
tags: ["search"]
---

# Search users

`GET /search/users`

Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.6/rest/guides/using-pagination-in-the-rest-api).

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](https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.6/rest/search/search#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.

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.6/graphql/reference/queries#search)."

## Query parameters

- `q` string, required
- `sort` 'followers' | 'repositories' | 'joined'
- `order` 'desc' | 'asc'
- `per_page` integer
- `page` integer

## Response `200`

Response

- object
  - `total_count` integer, required
  - `incomplete_results` boolean, required
  - `items` UserSearchResultItem[], required
    - `login` string, required
    - `id` integer, required
    - `node_id` string, required
    - `avatar_url` string, uri, required
    - `gravatar_id` string, nullable, required
    - `url` string, uri, required
    - `html_url` string, uri, required
    - `followers_url` string, uri, required
    - `subscriptions_url` string, uri, required
    - `organizations_url` string, uri, required
    - `repos_url` string, uri, required
    - `received_events_url` string, uri, required
    - `type` string, required
    - `score` number, required
    - `following_url` string, required
    - `gists_url` string, required
    - `starred_url` string, required
    - `events_url` string, required
    - `public_repos` integer
    - `public_gists` integer
    - `followers` integer
    - `following` integer
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string, nullable
    - `bio` string, nullable
    - `email` string, email, nullable
    - `location` string, nullable
    - `site_admin` boolean, required
    - `hireable` boolean, nullable
    - `text_matches` object[]
      - `object_url` string
      - `object_type` string, nullable
      - `property` string
      - `fragment` string
      - `matches` object[]
        - `text` string
        - `indices` integer[]
    - `blog` string, nullable
    - `company` string, nullable
    - `suspended_at` string, date-time, nullable

## Other responses

- `304` — Not modified
- `422` — Validation failed, or the endpoint has been spammed.
- `503` — Service unavailable

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-5.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-5/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-5/versions/50ae54440071/schema)