Magidoc

User
Object

A user is an individual's account on GitHub that owns repositories and can make new content.

Fields

#

anyPinnableItems

Boolean !
Non-null

Determine if this repository owner has any items that can be pinned to their profile.

avatarUrl

URI !
Non-null

A URL pointing to the user's public avatar.

bio

String

The user's public profile bio.

bioHTML

HTML !
Non-null

The user's public profile bio as HTML.

canReceiveOrganizationEmailsWhenNotificationsRestricted

Boolean !
Non-null

Could this user receive email notifications, if the organization had notification restrictions enabled?

commitComments

CommitCommentConnection !
Non-null

A list of commit comments made by this user.

company

String

The user's public profile company.

companyHTML

HTML !
Non-null

The user's public profile company as HTML.

contributionsCollection

ContributionsCollection !
Non-null

The collection of contributions this user has made to different repositories.

copilotEndpoints

CopilotEndpoints

The user's Copilot endpoint information

createdAt

DateTime !
Non-null

Identifies the date and time when the object was created.

databaseId

Int

Identifies the primary key from the database.

email

String !
Non-null

The user's publicly visible profile email.

enterprises

EnterpriseConnection

A list of enterprises that the user belongs to.

estimatedNextSponsorsPayoutInCents

Int !
Non-null

The estimated next GitHub Sponsors payout for this user/organization in cents (USD).

followers

FollowerConnection !
Non-null

A list of users the given user is followed by.

following

FollowingConnection !
Non-null

A list of users the given user is following.

gist

Gist

Find gist by repo name.

gistComments

GistCommentConnection !
Non-null

A list of gist comments made by this user.

gists

GistConnection !
Non-null

A list of the Gists the user has created.

hasSponsorsListing

Boolean !
Non-null

True if this user/organization has a GitHub Sponsors listing.

hovercard

Hovercard !
Non-null

The hovercard information for this user in a given context

id

ID !
Non-null

The Node ID of the User object

interactionAbility

RepositoryInteractionAbility

The interaction ability settings for this user.

isBountyHunter

Boolean !
Non-null

Whether or not this user is a participant in the GitHub Security Bug Bounty.

isCampusExpert

Boolean !
Non-null

Whether or not this user is a participant in the GitHub Campus Experts Program.

isDeveloperProgramMember

Boolean !
Non-null

Whether or not this user is a GitHub Developer Program member.

isEmployee

Boolean !
Non-null

Whether or not this user is a GitHub employee.

isFollowingViewer

Boolean !
Non-null

Whether or not this user is following the viewer. Inverse of viewerIsFollowing

isGitHubStar

Boolean !
Non-null

Whether or not this user is a member of the GitHub Stars Program.

isHireable

Boolean !
Non-null

Whether or not the user has marked themselves as for hire.

isSiteAdmin

Boolean !
Non-null

Whether or not this user is a site administrator.

isSponsoredBy

Boolean !
Non-null

Whether the given account is sponsoring this user/organization.

isSponsoringViewer

Boolean !
Non-null

True if the viewer is sponsored by this user/organization.

isViewer

Boolean !
Non-null

Whether or not this user is the viewing user.

issueComments

IssueCommentConnection !
Non-null

A list of issue comments made by this user.

issues

IssueConnection !
Non-null

A list of issues associated with this user.

itemShowcase

ProfileItemShowcase !
Non-null

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

lifetimeReceivedSponsorshipValues

SponsorAndLifetimeValueConnection !
Non-null

Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon.

lists

UserListConnection !
Non-null

A user-curated list of repositories

location

String

The user's public profile location.

login

String !
Non-null

The username used to login.

monthlyEstimatedSponsorsIncomeInCents

Int !
Non-null

The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).

name

String

The user's public profile name.

organization

Organization

Find an organization by its login that the user belongs to.

organizationVerifiedDomainEmails

[ String !]!
Non-null

Verified email addresses that match verified domains for a specified organization the user is a member of.

organizations

OrganizationConnection !
Non-null

A list of organizations the user belongs to.

packages

PackageConnection !
Non-null

A list of packages under the owner.

pinnableItems

PinnableItemConnection !
Non-null

A list of repositories and gists this profile owner can pin to their profile.

pinnedItems

PinnableItemConnection !
Non-null

A list of repositories and gists this profile owner has pinned to their profile

pinnedItemsRemaining

Int !
Non-null

Returns how many more items this profile owner can pin to their profile.

project

Project

Find project by number.

projectV2

ProjectV2

Find a project by number.

projects

ProjectConnection !
Non-null

A list of projects under the owner.

projectsResourcePath

URI !
Non-null

The HTTP path listing user's projects

projectsUrl

URI !
Non-null

The HTTP URL listing user's projects

projectsV2

ProjectV2Connection !
Non-null

A list of projects under the owner.

pronouns

String

The user's profile pronouns

publicKeys

PublicKeyConnection !
Non-null

A list of public keys associated with this user.

pullRequests

PullRequestConnection !
Non-null

A list of pull requests associated with this user.

recentProjects

ProjectV2Connection !
Non-null

Recent projects that this user has modified in the context of the owner.

repositories

RepositoryConnection !
Non-null

A list of repositories that the user owns.

repositoriesContributedTo

RepositoryConnection !
Non-null

A list of repositories that the user recently contributed to.

repository

Repository

Find Repository.

repositoryDiscussionComments

DiscussionCommentConnection !
Non-null

Discussion comments this user has authored.

repositoryDiscussions

DiscussionConnection !
Non-null

Discussions this user has started.

resourcePath

URI !
Non-null

The HTTP path for this user

savedReplies

SavedReplyConnection

Replies this user has saved

socialAccounts

SocialAccountConnection !
Non-null

The user's social media accounts, ordered as they appear on the user's profile.

sponsoring

SponsorConnection !
Non-null

List of users and organizations this entity is sponsoring.

sponsors

SponsorConnection !
Non-null

List of sponsors for this user or organization.

sponsorsActivities

SponsorsActivityConnection !
Non-null

Events involving this sponsorable, such as new sponsorships.

sponsorsListing

SponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor

Sponsorship

The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.

sponsorshipForViewerAsSponsorable

Sponsorship

The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.

sponsorshipNewsletters

SponsorshipNewsletterConnection !
Non-null

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer

SponsorshipConnection !
Non-null

The sponsorships where this user or organization is the maintainer receiving the funds.

sponsorshipsAsSponsor

SponsorshipConnection !
Non-null

The sponsorships where this user or organization is the funder.

starredRepositories

StarredRepositoryConnection !
Non-null

Repositories the user has starred.

status

UserStatus

The user's description of what they're currently doing.

suggestedListNames

[ UserListSuggestion !]!
Non-null

Suggested names for user lists

topRepositories

RepositoryConnection !
Non-null

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created

totalSponsorshipAmountAsSponsorInCents

Int

The amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization.

twitterUsername

String

The user's Twitter username.

updatedAt

DateTime !
Non-null

Identifies the date and time when the object was last updated.

url

URI !
Non-null

The HTTP URL for this user

viewerCanChangePinnedItems

Boolean !
Non-null

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects

Boolean !
Non-null

Can the current viewer create new projects on this owner.

viewerCanFollow

Boolean !
Non-null

Whether or not the viewer is able to follow the user.

viewerCanSponsor

Boolean !
Non-null

Whether or not the viewer is able to sponsor this user/organization.

viewerIsFollowing

Boolean !
Non-null

Whether or not this user is followed by the viewer. Inverse of isFollowingViewer.

viewerIsSponsoring

Boolean !
Non-null

True if the viewer is sponsoring this user/organization.

watching

RepositoryConnection !
Non-null

A list of repositories the given user is watching.

websiteUrl

URI

A URL pointing to the user's public website/blog.

Interfaces

#

Also implements Actor , Node , PackageOwner , ProfileOwner , ProjectOwner , ProjectV2Owner , ProjectV2Recent , RepositoryDiscussionAuthor , RepositoryDiscussionCommentAuthor , RepositoryOwner , Sponsorable , UniformResourceLocatable .

Usages

#

References

#