Get contextual information for a user

GET

/users/{username}/hovercard

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/users//hovercard'

Response Example

200 - Example 1

{
    "contexts": [
        {
            "message": "string",
            "octicon": "string"
        }
    ]
}

Request

Path Params

username

string

required

The handle for the GitHub user account.

Query Params

subject_type

string

optional

Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

subject_id

string

optional

Uses the ID for the subject_type you specified. Required when using subject_type.

Responses

🟢200Response

application/json

Body

Hovercard

contexts

array [object {2}]

required

message

string

required

octicon

string

required

🟠404404

🟠422422

Modified at 2023-08-15 02:59:30

List GPG keys for a user

List public keys for a user