Unions
A union is a type of object representing many objects.
In this article
About unions
Aunion is a type of object representing many objects.
For example, a field marked as anProjectCardItem could be anIssue or aPullRequest because each of those objects can be inside a project card. Using a union instead of an object gives you flexibility.
For more information, seeIntroduction to GraphQL.
BranchActorAllowanceActor
Types which can be actors forBranchActorAllowance objects.
BypassActor
Types that can represent a repository ruleset bypass actor.
Claimable
An object which can have its data claimed or claim data from another.
CreatedIssueOrRestrictedContribution
Represents either a issue the viewer can access or a restricted contribution.
Possible types forCreatedIssueOrRestrictedContribution
CreatedPullRequestOrRestrictedContribution
Represents either a pull request the viewer can access or a restricted contribution.
Possible types forCreatedPullRequestOrRestrictedContribution
CreatedRepositoryOrRestrictedContribution
Represents either a repository the viewer can access or a restricted contribution.
Possible types forCreatedRepositoryOrRestrictedContribution
IssueOrPullRequest
Used for return value of Repository.issueOrPullRequest.
Possible types forIssueOrPullRequest
IssueTimelineItems
An item in an issue timeline.
Possible types forIssueTimelineItems
AddedToProjectEventAssignedEventClosedEventCommentDeletedEventConnectedEventConvertedNoteToIssueEventConvertedToDiscussionEventCrossReferencedEventDemilestonedEventDisconnectedEventIssueCommentIssueTypeAddedEventIssueTypeChangedEventIssueTypeRemovedEventLabeledEventLockedEventMarkedAsDuplicateEventMentionedEventMilestonedEventMovedColumnsInProjectEventParentIssueAddedEventParentIssueRemovedEventPinnedEventReferencedEventRemovedFromProjectEventRenamedTitleEventReopenedEventSubIssueAddedEventSubIssueRemovedEventSubscribedEventTransferredEventUnassignedEventUnlabeledEventUnlockedEventUnmarkedAsDuplicateEventUnpinnedEventUnsubscribedEventUserBlockedEvent
OrgRestoreMemberAuditEntryMembership
Types of memberships that can be restored for an Organization member.
Possible types forOrgRestoreMemberAuditEntryMembership
OrganizationAuditEntry
An audit entry in an organization audit log.
Possible types forOrganizationAuditEntry
MembersCanDeleteReposClearAuditEntryMembersCanDeleteReposDisableAuditEntryMembersCanDeleteReposEnableAuditEntryOauthApplicationCreateAuditEntryOrgAddBillingManagerAuditEntryOrgAddMemberAuditEntryOrgBlockUserAuditEntryOrgConfigDisableCollaboratorsOnlyAuditEntryOrgConfigEnableCollaboratorsOnlyAuditEntryOrgCreateAuditEntryOrgDisableOauthAppRestrictionsAuditEntryOrgDisableSamlAuditEntryOrgDisableTwoFactorRequirementAuditEntryOrgEnableOauthAppRestrictionsAuditEntryOrgEnableSamlAuditEntryOrgEnableTwoFactorRequirementAuditEntryOrgInviteMemberAuditEntryOrgInviteToBusinessAuditEntryOrgOauthAppAccessApprovedAuditEntryOrgOauthAppAccessBlockedAuditEntryOrgOauthAppAccessDeniedAuditEntryOrgOauthAppAccessRequestedAuditEntryOrgOauthAppAccessUnblockedAuditEntryOrgRemoveBillingManagerAuditEntryOrgRemoveMemberAuditEntryOrgRemoveOutsideCollaboratorAuditEntryOrgRestoreMemberAuditEntryOrgUnblockUserAuditEntryOrgUpdateDefaultRepositoryPermissionAuditEntryOrgUpdateMemberAuditEntryOrgUpdateMemberRepositoryCreationPermissionAuditEntryOrgUpdateMemberRepositoryInvitationPermissionAuditEntryPrivateRepositoryForkingDisableAuditEntryPrivateRepositoryForkingEnableAuditEntryRepoAccessAuditEntryRepoAddMemberAuditEntryRepoAddTopicAuditEntryRepoArchivedAuditEntryRepoChangeMergeSettingAuditEntryRepoConfigDisableAnonymousGitAccessAuditEntryRepoConfigDisableCollaboratorsOnlyAuditEntryRepoConfigDisableContributorsOnlyAuditEntryRepoConfigDisableSockpuppetDisallowedAuditEntryRepoConfigEnableAnonymousGitAccessAuditEntryRepoConfigEnableCollaboratorsOnlyAuditEntryRepoConfigEnableContributorsOnlyAuditEntryRepoConfigEnableSockpuppetDisallowedAuditEntryRepoConfigLockAnonymousGitAccessAuditEntryRepoConfigUnlockAnonymousGitAccessAuditEntryRepoCreateAuditEntryRepoDestroyAuditEntryRepoRemoveMemberAuditEntryRepoRemoveTopicAuditEntryRepositoryVisibilityChangeDisableAuditEntryRepositoryVisibilityChangeEnableAuditEntryTeamAddMemberAuditEntryTeamAddRepositoryAuditEntryTeamChangeParentTeamAuditEntryTeamRemoveMemberAuditEntryTeamRemoveRepositoryAuditEntry
OrganizationOrUser
Used for argument of CreateProjectV2 mutation.
Possible types forOrganizationOrUser
PermissionGranter
Types that can grant permissions on a repository to a user.
Possible types forPermissionGranter
ProjectV2FieldConfiguration
Configurations for project fields.
Possible types forProjectV2FieldConfiguration
ProjectV2ItemFieldValue
Project field values.
Possible types forProjectV2ItemFieldValue
ProjectV2ItemFieldDateValueProjectV2ItemFieldIterationValueProjectV2ItemFieldLabelValueProjectV2ItemFieldMilestoneValueProjectV2ItemFieldNumberValueProjectV2ItemFieldPullRequestValueProjectV2ItemFieldRepositoryValueProjectV2ItemFieldReviewerValueProjectV2ItemFieldSingleSelectValueProjectV2ItemFieldTextValueProjectV2ItemFieldUserValue
PullRequestTimelineItem
An item in a pull request timeline.
Possible types forPullRequestTimelineItem
AssignedEventBaseRefDeletedEventBaseRefForcePushedEventClosedEventCommitCommitCommentThreadCrossReferencedEventDemilestonedEventDeployedEventDeploymentEnvironmentChangedEventHeadRefDeletedEventHeadRefForcePushedEventHeadRefRestoredEventIssueCommentLabeledEventLockedEventMergedEventMilestonedEventPullRequestReviewPullRequestReviewCommentPullRequestReviewThreadReferencedEventRenamedTitleEventReopenedEventReviewDismissedEventReviewRequestRemovedEventReviewRequestedEventSubscribedEventUnassignedEventUnlabeledEventUnlockedEventUnsubscribedEventUserBlockedEvent
PullRequestTimelineItems
An item in a pull request timeline.
Possible types forPullRequestTimelineItems
AddedToMergeQueueEventAddedToProjectEventAssignedEventAutoMergeDisabledEventAutoMergeEnabledEventAutoRebaseEnabledEventAutoSquashEnabledEventAutomaticBaseChangeFailedEventAutomaticBaseChangeSucceededEventBaseRefChangedEventBaseRefDeletedEventBaseRefForcePushedEventClosedEventCommentDeletedEventConnectedEventConvertToDraftEventConvertedNoteToIssueEventConvertedToDiscussionEventCrossReferencedEventDemilestonedEventDeployedEventDeploymentEnvironmentChangedEventDisconnectedEventHeadRefDeletedEventHeadRefForcePushedEventHeadRefRestoredEventIssueCommentIssueTypeAddedEventIssueTypeChangedEventIssueTypeRemovedEventLabeledEventLockedEventMarkedAsDuplicateEventMentionedEventMergedEventMilestonedEventMovedColumnsInProjectEventParentIssueAddedEventParentIssueRemovedEventPinnedEventPullRequestCommitPullRequestCommitCommentThreadPullRequestReviewPullRequestReviewThreadPullRequestRevisionMarkerReadyForReviewEventReferencedEventRemovedFromMergeQueueEventRemovedFromProjectEventRenamedTitleEventReopenedEventReviewDismissedEventReviewRequestRemovedEventReviewRequestedEventSubIssueAddedEventSubIssueRemovedEventSubscribedEventTransferredEventUnassignedEventUnlabeledEventUnlockedEventUnmarkedAsDuplicateEventUnpinnedEventUnsubscribedEventUserBlockedEvent
RequestedReviewer
Types that can be requested reviewers.
ReviewDismissalAllowanceActor
Types that can be an actor.
RuleParameters
Types which can be parameters forRepositoryRule objects.
Possible types forRuleParameters
BranchNamePatternParametersCodeScanningParametersCommitAuthorEmailPatternParametersCommitMessagePatternParametersCommitterEmailPatternParametersFileExtensionRestrictionParametersFilePathRestrictionParametersMaxFilePathLengthParametersMaxFileSizeParametersMergeQueueParametersPullRequestParametersRequiredDeploymentsParametersRequiredStatusChecksParametersTagNamePatternParametersUpdateParametersWorkflowsParameters
SponsorsListingFeatureableItem
A record that can be featured on a GitHub Sponsors profile.
Possible types forSponsorsListingFeatureableItem
StatusCheckRollupContext
Types that can be inside a StatusCheckRollup context.