dreamworkAPI
Ctrl K
GitHub
typeDocs / http / github / User

http.github.User

typesharedmenusource

A GitHub user.

Fields

NameTypeDescription
idintegerUnique numeric ID of the user on GitHub.
loginstringGitHub username.
avatar_urlstringGitHub user avatar URL.
typestringType of GitHub account: "User" for individuals, "Organization" for orgs.
urlstringAPI URL to fetch general user profile data in JSON.
user_view_typestringNot a standard GitHub field in public APIs; (likely indicates visibility like "public" or "private" view).
followers_urlstringAPI endpoint to fetch users who follow this user.
following_urlstringTemplate URL for users this user is following. Replace {other_user} with a username to check specific following status.
gists_urlstringTemplate API URL to fetch gists (code snippets) by this user. {gist_id} is optional to target a specific gist.
html_urlstringURL to the user’s GitHub profile (viewed in browser).
node_idstringInternal GitHub GraphQL node ID, base64-encoded.
organizations_urlstringAPI URL to fetch organizations this user belongs to.
received_events_urlstringAPI URL to list GitHub events received by this user (e.g., starred, forked repos).
repos_urlstringAPI URL to list this user’s public repositories.
site_adminbooleantrue if the user is a GitHub staff/admin, false otherwise.
starred_urlstringTemplate API URL to see repositories starred by this user. Replace {owner} and {repo} with specific values if needed.
subscriptions_urlstringAPI URL to fetch repos this user is subscribed to (watching for updates).

Subclasses

http.github.Contributor

Generated from the dreamwork meta branch.