Search GitHub users

Full-text search across user login, name, bio, company, and location using BM25 ranking. Results include relevance scores. Requires SEARCH service. Credits: 1 per result returned + graph relationship credits if includeAttributes is specified.

post/search/users

Request body

maxResultsinteger

Maximum number of results to return (default: 100, max: 1000)

firstinteger

Alias for maxResults (takes precedence if both provided)

enablePaginationboolean

Enable cursor-based pagination to fetch results across multiple requests

afterstring

Cursor for pagination (from previous response pageInfo.endCursor)

dataset'standard' | 'professional'

Which dataset to search. 'standard' uses the base namespace; 'professional' uses the LinkedIn-enriched namespace with additional professional fields.

Example request

{
  "maxResults": 50,
  "first": 50,
  "enablePagination": true,
  "after": "Y3Vyc29yOjEyMzQ1",
  "dataset": "standard"
}

Response

Search results retrieved successfully

SearchUsersResponse required— unresolved $ref

Changes

Changed in 6 of the 43 revisions of this API.815

    • added the new optional request property dataset

      new-optional-request-property

  • 0d3c77ff90a766See the full diff
    • removed subschema #1 subschema #2 subschema #3 from the filters/allOf[UserFilter]/ request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 subschema #3 from the includeAttributes/allOf[UserIncludeAttributes]/contributes/filters request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 subschema #3 from the includeAttributes/allOf[UserIncludeAttributes]/followers/filters request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 subschema #3 from the includeAttributes/allOf[UserIncludeAttributes]/following/filters request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 subschema #3 from the includeAttributes/allOf[UserIncludeAttributes]/owns/filters request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 subschema #3 from the includeAttributes/allOf[UserIncludeAttributes]/stars/filters request property anyOf list

      request-property-any-of-removed

    • added subschema #1 subschema #2 subschema #3 to the filters/allOf[UserFilter]/ request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 subschema #3 to the includeAttributes/allOf[UserIncludeAttributes]/contributes/filters request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 subschema #3 to the includeAttributes/allOf[UserIncludeAttributes]/followers/filters request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 subschema #3 to the includeAttributes/allOf[UserIncludeAttributes]/following/filters request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 subschema #3 to the includeAttributes/allOf[UserIncludeAttributes]/owns/filters request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 subschema #3 to the includeAttributes/allOf[UserIncludeAttributes]/stars/filters request property anyOf list

      request-property-any-of-added

    • the response property users/items/allOf[subschema #2]/ became nullable for the status 200

      response-property-became-nullable

    • added the new optional request property includeAttributes/allOf[UserIncludeAttributes]/aggregates

      new-optional-request-property

    • added the optional property users/items/allOf[PublicUserWithDevrank]/allOf[subschema #2]/aggregates to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed subschema #4 from the query request property anyOf list

      request-property-any-of-removed

    • added the new optional request property includeAttributes/allOf[UserIncludeAttributes]/professional

      new-optional-request-property

    • added the optional property users/items/allOf[PublicUserWithDevrank]/allOf[subschema #2]/professional to the response with the 200 status

      response-optional-property-added

    • added the optional property users/items/allOf[subschema #2]/contributes/allOf[PaginatedRepositories]/edges/items/allOf[subschema #2]/ownerProfessional to the response with the 200 status

      response-optional-property-added

    • added the optional property users/items/allOf[subschema #2]/owns/allOf[PaginatedRepositories]/edges/items/allOf[subschema #2]/ownerProfessional to the response with the 200 status

      response-optional-property-added

    • added the optional property users/items/allOf[subschema #2]/stars/edges/items/allOf[subschema #2]/ownerProfessional to the response with the 200 status

      response-optional-property-added

    • endpoint added

      endpoint-added