Users

Reference documentation for GraphQL schema types in the Users category.

Actor - interface

Represents an object which can take actions on GitHub. Typically a User or Bot.

Fields for Actor

Implemented by

ActorConnection - object

The connection type for Actor.

Fields for ActorConnection

ActorEdge - object

An edge in a connection.

Fields for ActorEdge

ActorLocation - object

Location information for an actor.

Fields for ActorLocation

ActorType - enum

The actor's type.

Values for ActorType

AgentAssignmentInput - input object

Represents configuration for assigning Copilot to an issue (public variant).

Input fields for AgentAssignmentInput

changeUserStatus - mutation

Update your status on GitHub.

Input fields for changeUserStatus

Return fields for changeUserStatus

ChangeUserStatusInput - input object

Autogenerated input type of ChangeUserStatus.

Input fields for ChangeUserStatusInput

Claimable - union

An object which can have its data claimed or claim data from another.

Possible types for Claimable

Contribution - interface

Represents a contribution a user made on GitHub, such as opening an issue.

Fields for Contribution

Implemented by

ContributionCalendar - object

A calendar of contributions made on GitHub by a user.

Fields for ContributionCalendar

ContributionCalendarDay - object

Represents a single day of contributions on GitHub by a user.

Fields for ContributionCalendarDay

ContributionCalendarMonth - object

A month of contributions in a user's contribution graph.

Fields for ContributionCalendarMonth

ContributionCalendarWeek - object

A week of contributions in a user's contribution graph.

Fields for ContributionCalendarWeek

ContributionLevel - enum

Varying levels of contributions from none to many.

Values for ContributionLevel

ContributionOrder - input object

Ordering options for contribution connections.

Input fields for ContributionOrder

ContributionsCollection - object

A collection of contributions made by a user, including opened issues, commits, and pull requests.
Contributions in private and internal repositories are only included with the optional read:user scope.

Fields for ContributionsCollection

CreatedCommitContribution - object

Represents the contribution a user made by committing to a repository.

Implements: Contribution

Fields for CreatedCommitContribution

CreatedCommitContributionConnection - object

The connection type for CreatedCommitContribution.

Fields for CreatedCommitContributionConnection

CreatedCommitContributionEdge - object

An edge in a connection.

Fields for CreatedCommitContributionEdge

CreatedIssueContribution - object

Represents the contribution a user made on GitHub by opening an issue.

Implements: Contribution

Fields for CreatedIssueContribution

CreatedIssueContributionConnection - object

The connection type for CreatedIssueContribution.

Fields for CreatedIssueContributionConnection

CreatedIssueContributionEdge - object

An edge in a connection.

Fields for CreatedIssueContributionEdge

CreatedIssueOrRestrictedContribution - union

Represents either a issue the viewer can access or a restricted contribution.

Possible types for CreatedIssueOrRestrictedContribution

CreatedPullRequestContribution - object

Represents the contribution a user made on GitHub by opening a pull request.

Implements: Contribution

Fields for CreatedPullRequestContribution

CreatedPullRequestContributionConnection - object

The connection type for CreatedPullRequestContribution.

Fields for CreatedPullRequestContributionConnection

CreatedPullRequestContributionEdge - object

An edge in a connection.

Fields for CreatedPullRequestContributionEdge

CreatedPullRequestOrRestrictedContribution - union

Represents either a pull request the viewer can access or a restricted contribution.

Possible types for CreatedPullRequestOrRestrictedContribution

CreatedPullRequestReviewContribution - object

Represents the contribution a user made by leaving a review on a pull request.

Implements: Contribution

Fields for CreatedPullRequestReviewContribution

CreatedPullRequestReviewContributionConnection - object

The connection type for CreatedPullRequestReviewContribution.

Fields for CreatedPullRequestReviewContributionConnection

CreatedPullRequestReviewContributionEdge - object

An edge in a connection.

Fields for CreatedPullRequestReviewContributionEdge

CreatedRepositoryContribution - object

Represents the contribution a user made on GitHub by creating a repository.

Implements: Contribution

Fields for CreatedRepositoryContribution

CreatedRepositoryContributionConnection - object

The connection type for CreatedRepositoryContribution.

Fields for CreatedRepositoryContributionConnection

CreatedRepositoryContributionEdge - object

An edge in a connection.

Fields for CreatedRepositoryContributionEdge

CreatedRepositoryOrRestrictedContribution - union

Represents either a repository the viewer can access or a restricted contribution.

Possible types for CreatedRepositoryOrRestrictedContribution

createUserList - mutation

Creates a new user list.

Input fields for createUserList

Return fields for createUserList

CreateUserListInput - input object

Autogenerated input type of CreateUserList.

Input fields for CreateUserListInput

deleteUserList - mutation

Deletes a user list.

Input fields for deleteUserList

Return fields for deleteUserList

DeleteUserListInput - input object

Autogenerated input type of DeleteUserList.

Input fields for DeleteUserListInput

EnterpriseAdministratorConnection - object

The connection type for User.

Fields for EnterpriseAdministratorConnection

EnterpriseAdministratorEdge - object

A User who is an administrator of an enterprise.

Fields for EnterpriseAdministratorEdge

EnterpriseOutsideCollaboratorConnection - object

The connection type for User.

Fields for EnterpriseOutsideCollaboratorConnection

EnterpriseOutsideCollaboratorEdge - object

A User who is an outside collaborator of an enterprise through one or more organizations.

Fields for EnterpriseOutsideCollaboratorEdge

EnterpriseTeamMemberConnection - object

The connection type for User.

Fields for EnterpriseTeamMemberConnection

EnterpriseTeamMemberEdge - object

Represents a user who is a member of an enterprise team.

Fields for EnterpriseTeamMemberEdge

FollowerConnection - object

The connection type for User.

Fields for FollowerConnection

FollowingConnection - object

The connection type for User.

Fields for FollowingConnection

followUser - mutation

Follow a user.

Input fields for followUser

Return fields for followUser

FollowUserInput - input object

Autogenerated input type of FollowUser.

Input fields for FollowUserInput

GenericHovercardContext - object

A generic hovercard context with a message and icon.

Implements: HovercardContext

Fields for GenericHovercardContext

Hovercard - object

Detail needed to display a hovercard for a user.

Fields for Hovercard

HovercardContext - interface

An individual line of a hovercard.

Fields for HovercardContext

Implemented by

JoinedGitHubContribution - object

Represents a user signing up for a GitHub account.

Implements: Contribution

Fields for JoinedGitHubContribution

MemberStatusable - interface

Entities that have members who can set status messages.

Fields for MemberStatusable

Implemented by

OrganizationEnterpriseOwnerConnection - object

The connection type for User.

Fields for OrganizationEnterpriseOwnerConnection

OrganizationEnterpriseOwnerEdge - object

An enterprise owner in the context of an organization that is part of the enterprise.

Fields for OrganizationEnterpriseOwnerEdge

OrganizationMemberConnection - object

A list of users who belong to the organization.

Fields for OrganizationMemberConnection

OrganizationMemberEdge - object

Represents a user within an organization.

Fields for OrganizationMemberEdge

Pinnable - interface

Entities that can be pinned.

Fields for Pinnable

Implemented by

PinnableItem - union

Types that can be pinned to a profile page.

Possible types for PinnableItem

PinnableItemConnection - object

The connection type for PinnableItem.

Fields for PinnableItemConnection

PinnableItemEdge - object

An edge in a connection.

Fields for PinnableItemEdge

PinnableItemType - enum

Represents items that can be pinned to a profile page or dashboard.

Values for PinnableItemType

ProfileItemShowcase - object

A curatable list of repositories relating to a repository owner, which defaults
to showing the most popular repositories they own.

Fields for ProfileItemShowcase

ProfileOwner - interface

Represents any entity on GitHub that has a profile page.

Fields for ProfileOwner

Implemented by

PublicKey - object

A user's public key.

Implements: Node

Fields for PublicKey

PublicKeyConnection - object

The connection type for PublicKey.

Fields for PublicKeyConnection

PublicKeyEdge - object

An edge in a connection.

Fields for PublicKeyEdge

ReactingUserConnection - object

The connection type for User.

Fields for ReactingUserConnection

ReactingUserEdge - object

Represents a user that's made a reaction.

Fields for ReactingUserEdge

RepositoryCollaboratorConnection - object

The connection type for User.

Fields for RepositoryCollaboratorConnection

RepositoryCollaboratorEdge - object

Represents a user who is a collaborator of a repository.

Fields for RepositoryCollaboratorEdge

RestrictedContribution - object

Represents a private contribution a user made on GitHub.

Implements: Contribution

Fields for RestrictedContribution

SavedReply - object

A Saved Reply is text a user can use to reply quickly.

Implements: Node

Fields for SavedReply

SavedReplyConnection - object

The connection type for SavedReply.

Fields for SavedReplyConnection

SavedReplyEdge - object

An edge in a connection.

Fields for SavedReplyEdge

SavedReplyOrder - input object

Ordering options for saved reply connections.

Input fields for SavedReplyOrder

SavedReplyOrderField - enum

Properties by which saved reply connections can be ordered.

Values for SavedReplyOrderField

setUserInteractionLimit - mutation

Set a user level interaction limit for an user's public repositories.

Input fields for setUserInteractionLimit

Return fields for setUserInteractionLimit

SetUserInteractionLimitInput - input object

Autogenerated input type of SetUserInteractionLimit.

Input fields for SetUserInteractionLimitInput

SocialAccount - object

Social media profile associated with a user.

Fields for SocialAccount

SocialAccountConnection - object

The connection type for SocialAccount.

Fields for SocialAccountConnection

SocialAccountEdge - object

An edge in a connection.

Fields for SocialAccountEdge

SocialAccountProvider - enum

Software or company that hosts social media accounts.

Values for SocialAccountProvider

StargazerConnection - object

The connection type for User.

Fields for StargazerConnection

StargazerEdge - object

Represents a user that's starred a repository.

Fields for StargazerEdge

TeamMemberConnection - object

The connection type for User.

Fields for TeamMemberConnection

TeamMemberEdge - object

Represents a user who is a member of a team.

Fields for TeamMemberEdge

unfollowUser - mutation

Unfollow a user.

Input fields for unfollowUser

Return fields for unfollowUser

UnfollowUserInput - input object

Autogenerated input type of UnfollowUser.

Input fields for UnfollowUserInput

updateUserList - mutation

Updates an existing user list.

Input fields for updateUserList

Return fields for updateUserList

UpdateUserListInput - input object

Autogenerated input type of UpdateUserList.

Input fields for UpdateUserListInput

updateUserListsForItem - mutation

Updates which of the viewer's lists an item belongs to.

Input fields for updateUserListsForItem

Return fields for updateUserListsForItem

UpdateUserListsForItemInput - input object

Autogenerated input type of UpdateUserListsForItem.

Input fields for UpdateUserListsForItemInput

User - object

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

Implements: Actor, Agentic, Node, PackageOwner, ProfileOwner, ProjectOwner, ProjectV2Owner, ProjectV2Recent, RepositoryDiscussionAuthor, RepositoryDiscussionCommentAuthor, RepositoryOwner, Sponsorable, UniformResourceLocatable

Fields for User

user - query

Lookup a user by login.

Type: User

Arguments for user

UserBlockDuration - enum

The possible durations that a user can be blocked for.

Values for UserBlockDuration

UserBlockedEvent - object

Represents a user_blocked event on a given user.

Implements: Node

Fields for UserBlockedEvent

UserConnection - object

A list of users.

Fields for UserConnection

UserContentEdit - object

An edit on user content.

Implements: Node

Fields for UserContentEdit

UserContentEditConnection - object

A list of edits to content.

Fields for UserContentEditConnection

UserContentEditEdge - object

An edge in a connection.

Fields for UserContentEditEdge

UserEdge - object

Represents a user.

Fields for UserEdge

UserEmailMetadata - object

Email attributes from External Identity.

Fields for UserEmailMetadata

UserList - object

A user-curated list of repositories.

Implements: Node

Fields for UserList

UserListConnection - object

The connection type for UserList.

Fields for UserListConnection

UserListEdge - object

An edge in a connection.

Fields for UserListEdge

UserListItems - union

Types that can be added to a user list.

Possible types for UserListItems

UserListItemsConnection - object

The connection type for UserListItems.

Fields for UserListItemsConnection

UserListItemsEdge - object

An edge in a connection.

Fields for UserListItemsEdge

UserListSuggestion - object

Represents a suggested user list.

Fields for UserListSuggestion

UserStatus - object

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

Implements: Node

Fields for UserStatus

UserStatusConnection - object

The connection type for UserStatus.

Fields for UserStatusConnection

UserStatusEdge - object

An edge in a connection.

Fields for UserStatusEdge

UserStatusOrder - input object

Ordering options for user status connections.

Input fields for UserStatusOrder

UserStatusOrderField - enum

Properties by which user status connections can be ordered.

Values for UserStatusOrderField

UserViewType - enum

Whether a user being viewed contains public or private information.

Values for UserViewType

viewer - query

The currently authenticated user.

Type: User!

ViewerHovercardContext - object

A hovercard context with a message describing how the viewer is related.

Implements: HovercardContext

Fields for ViewerHovercardContext