RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.github.com/en/rest/users/users below:

REST API endpoints for users

Use the REST API to get public and private information about authenticated users.

Get the authenticated user Code samples for "Get the authenticated user" Request examples

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user

Response with public and private profile information

Status: 200

{ "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } }

Update the authenticated user

Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

Fine-grained access tokens for "Update the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Profile" user permissions (write)

Parameters for "Update the authenticated user" Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Body parameters Name, Type, Description

name string

The new name of the user.

email string

The publicly visible email address of the user.

blog string

The new blog URL of the user.

twitter_username string or null

The new Twitter username of the user.

company string

The new company of the user.

location string

The new location of the user.

hireable boolean

The new hiring availability of the user.

bio string

The new short biography of the user.

HTTP response status codes for "Update the authenticated user" Status code Description 200

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Code samples for "Update the authenticated user" Request example

Copy to clipboard curl request example

curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user \ -d '{"blog":"https://github.com/blog","name":"monalisa octocat"}'

Response

Status: 200

Get a user using their ID

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

Fine-grained access tokens for "Get a user using their ID"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

This endpoint can be used without authentication if only public resources are requested.

Parameters for "Get a user using their ID" Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

account_id integer Required

account_id parameter

HTTP response status codes for "Get a user using their ID" Status code Description 200

404

Resource not found

Code samples for "Get a user using their ID" Request examples

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/ACCOUNT_ID

Default response

Status: 200

List users Code samples for "List users" Request example

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users

Response

Status: 200

[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

Get a user

Provides publicly available information about someone with a GitHub account.

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

Fine-grained access tokens for "Get a user"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

This endpoint can be used without authentication if only public resources are requested.

Parameters for "Get a user" Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

username string Required

The handle for the GitHub user account.

HTTP response status codes for "Get a user" Status code Description 200

404

Resource not found

Code samples for "Get a user" Request examples

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME

Default response

Status: 200

Get contextual information for a user

Provides hovercard information. 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, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Fine-grained access tokens for "Get contextual information for a user"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Get contextual information for a user" Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

username string Required

The handle for the GitHub user account.

Query parameters Name, Type, Description

subject_type string

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.

Can be one of: organization, repository, issue, pull_request

subject_id string

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

HTTP response status codes for "Get contextual information for a user" Status code Description 200

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Code samples for "Get contextual information for a user" Request example

get/users/{username}/hovercard

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/hovercard

Response

Status: 200

{ "contexts": [ { "message": "Owns this repository", "octicon": "repo" } ] }

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4