Enums

In this article

About enums

Enums represent possible sets of values for a field.

For example, the Issue object has a field called state. The state is an enum (specifically, of type IssueState) because it may be OPEN or CLOSED.

For more information, see "Introduction to GraphQL."

AuditLogOrderField

Properties by which Audit Log connections can be ordered.

Values

CREATED_AT

Order audit log entries by timestamp.


CheckAnnotationLevel

Represents an annotation's information level.

Values

FAILURE

An annotation indicating an inescapable error.

NOTICE

An annotation indicating some information.

WARNING

An annotation indicating an ignorable error.


CheckConclusionState

The possible states for a check suite or run conclusion.

Values

ACTION_REQUIRED

The check suite or run requires action.

CANCELLED

The check suite or run has been cancelled.

FAILURE

The check suite or run has failed.

NEUTRAL

The check suite or run was neutral.

SKIPPED

The check suite or run was skipped.

STALE

The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.

STARTUP_FAILURE

The check suite or run has failed at startup.

SUCCESS

The check suite or run has succeeded.

TIMED_OUT

The check suite or run has timed out.


CheckRunType

The possible types of check runs.

Values

ALL

Every check run available.

LATEST

The latest check run.


CheckStatusState

The possible states for a check suite or run status.

Values

COMPLETED

The check suite or run has been completed.

IN_PROGRESS

The check suite or run is in progress.

QUEUED

The check suite or run has been queued.

REQUESTED

The check suite or run has been requested.


CollaboratorAffiliation

Collaborators affiliation level with a subject.

Values

ALL

All collaborators the authenticated user can see.

DIRECT

All collaborators with permissions to an organization-owned subject, regardless of organization membership status.

OUTSIDE

All outside collaborators of an organization-owned subject.


CommentAuthorAssociation

A comment author association with repository.

Values

COLLABORATOR

Author has been invited to collaborate on the repository.

CONTRIBUTOR

Author has previously committed to the repository.

FIRST_TIMER

Author has not previously committed to GitHub.

FIRST_TIME_CONTRIBUTOR

Author has not previously committed to the repository.

MANNEQUIN

Author is a placeholder for an unclaimed user.

MEMBER

Author is a member of the organization that owns the repository.

NONE

Author has no association with the repository.

OWNER

Author is the owner of the repository.


CommentCannotUpdateReason

The possible errors that will prevent a user from updating a comment.

Values

ARCHIVED

Unable to create comment because repository is archived.

DENIED

You cannot update this comment.

INSUFFICIENT_ACCESS

You must be the author or have write access to this repository to update this comment.

LOCKED

Unable to create comment because issue is locked.

LOGIN_REQUIRED

You must be logged in to update this comment.

MAINTENANCE

Repository is under maintenance.

VERIFIED_EMAIL_REQUIRED

At least one email address must be verified to update this comment.


CommitContributionOrderField

Properties by which commit contribution connections can be ordered.

Values

COMMIT_COUNT

Order commit contributions by how many commits they represent.

OCCURRED_AT

Order commit contributions by when they were made.


DefaultRepositoryPermissionField

The possible default permissions for repositories.

Values

ADMIN

Can read, write, and administrate repos by default.

NONE

No access.

READ

Can read repos by default.

WRITE

Can read and write repos by default.


DeploymentOrderField

Properties by which deployment connections can be ordered.

Values

CREATED_AT

Order collection by creation time.


DeploymentState

The possible states in which a deployment can be.

Values

ABANDONED

The pending deployment was not updated after 30 minutes.

ACTIVE

The deployment is currently active.

DESTROYED

An inactive transient deployment.

ERROR

The deployment experienced an error.

FAILURE

The deployment has failed.

INACTIVE

The deployment is inactive.

IN_PROGRESS

The deployment is in progress.

PENDING

The deployment is pending.

QUEUED

The deployment has queued.

WAITING

The deployment is waiting.


DeploymentStatusState

The possible states for a deployment status.

Values

ERROR

The deployment experienced an error.

FAILURE

The deployment has failed.

INACTIVE

The deployment is inactive.

IN_PROGRESS

The deployment is in progress.

PENDING

The deployment is pending.

QUEUED

The deployment is queued.

SUCCESS

The deployment was successful.


DiffSide

The possible sides of a diff.

Values

LEFT

The left side of the diff.

RIGHT

The right side of the diff.


EnterpriseAdministratorInvitationOrderField

Properties by which enterprise administrator invitation connections can be ordered.

Values

CREATED_AT

Order enterprise administrator member invitations by creation time.


EnterpriseAdministratorRole

The possible administrator roles in an enterprise account.

Values

BILLING_MANAGER

Represents a billing manager of the enterprise account.

OWNER

Represents an owner of the enterprise account.


EnterpriseDefaultRepositoryPermissionSettingValue

The possible values for the enterprise default repository permission setting.

Values

ADMIN

Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.

NONE

Organization members will only be able to clone and pull public repositories.

NO_POLICY

Organizations in the enterprise choose default repository permissions for their members.

READ

Organization members will be able to clone and pull all organization repositories.

WRITE

Organization members will be able to clone, pull, and push all organization repositories.


EnterpriseEnabledDisabledSettingValue

The possible values for an enabled/disabled enterprise setting.

Values

DISABLED

The setting is disabled for organizations in the enterprise.

ENABLED

The setting is enabled for organizations in the enterprise.

NO_POLICY

There is no policy set for organizations in the enterprise.


EnterpriseEnabledSettingValue

The possible values for an enabled/no policy enterprise setting.

Values

ENABLED

The setting is enabled for organizations in the enterprise.

NO_POLICY

There is no policy set for organizations in the enterprise.


EnterpriseMemberOrderField

Properties by which enterprise member connections can be ordered.

Values

CREATED_AT

Order enterprise members by creation time.

LOGIN

Order enterprise members by login.


EnterpriseMembersCanCreateRepositoriesSettingValue

The possible values for the enterprise members can create repositories setting.

Values

ALL

Members will be able to create public and private repositories.

DISABLED

Members will not be able to create public or private repositories.

NO_POLICY

Organization administrators choose whether to allow members to create repositories.

PRIVATE

Members will be able to create only private repositories.

PUBLIC

Members will be able to create only public repositories.


EnterpriseMembersCanMakePurchasesSettingValue

The possible values for the members can make purchases setting.

Values

DISABLED

The setting is disabled for organizations in the enterprise.

ENABLED

The setting is enabled for organizations in the enterprise.


EnterpriseServerInstallationOrderField

Properties by which Enterprise Server installation connections can be ordered.

Values

CREATED_AT

Order Enterprise Server installations by creation time.

CUSTOMER_NAME

Order Enterprise Server installations by customer name.

HOST_NAME

Order Enterprise Server installations by host name.


EnterpriseServerUserAccountEmailOrderField

Properties by which Enterprise Server user account email connections can be ordered.

Values

EMAIL

Order emails by email.


EnterpriseServerUserAccountOrderField

Properties by which Enterprise Server user account connections can be ordered.

Values

LOGIN

Order user accounts by login.

REMOTE_CREATED_AT

Order user accounts by creation time on the Enterprise Server installation.


EnterpriseServerUserAccountsUploadOrderField

Properties by which Enterprise Server user accounts upload connections can be ordered.

Values

CREATED_AT

Order user accounts uploads by creation time.


EnterpriseServerUserAccountsUploadSyncState

Synchronization state of the Enterprise Server user accounts upload.

Values

FAILURE

The synchronization of the upload failed.

PENDING

The synchronization of the upload is pending.

SUCCESS

The synchronization of the upload succeeded.


EnterpriseUserAccountMembershipRole

The possible roles for enterprise membership.

Values

MEMBER

The user is a member of the enterprise membership.

OWNER

The user is an owner of the enterprise membership.


EnterpriseUserDeployment

The possible GitHub Enterprise deployments where this user can exist.

Values

CLOUD

The user is part of a GitHub Enterprise Cloud deployment.

SERVER

The user is part of a GitHub Enterprise Server deployment.


FileViewedState

The possible viewed states of a file .

Values

DISMISSED

The file has new changes since last viewed.

UNVIEWED

The file has not been marked as viewed.

VIEWED

The file has been marked as viewed.


FundingPlatform

The possible funding platforms for repository funding links.

Values

COMMUNITY_BRIDGE

Community Bridge funding platform.

CUSTOM

Custom funding platform.

GITHUB

GitHub funding platform.

ISSUEHUNT

IssueHunt funding platform.

KO_FI

Ko-fi funding platform.

LIBERAPAY

Liberapay funding platform.

OPEN_COLLECTIVE

Open Collective funding platform.

OTECHIE

Otechie funding platform.

PATREON

Patreon funding platform.

TIDELIFT

Tidelift funding platform.


GistOrderField

Properties by which gist connections can be ordered.

Values

CREATED_AT

Order gists by creation time.

PUSHED_AT

Order gists by push time.

UPDATED_AT

Order gists by update time.


GistPrivacy

The privacy of a Gist.

Values

ALL

Gists that are public and secret.

PUBLIC

Public.

SECRET

Secret.


GitSignatureState

The state of a Git signature.

Values

BAD_CERT

The signing certificate or its chain could not be verified.

BAD_EMAIL

Invalid email used for signing.

EXPIRED_KEY

Signing key expired.

GPGVERIFY_ERROR

Internal error - the GPG verification service misbehaved.

GPGVERIFY_UNAVAILABLE

Internal error - the GPG verification service is unavailable at the moment.

INVALID

Invalid signature.

MALFORMED_SIG

Malformed signature.

NOT_SIGNING_KEY

The usage flags for the key that signed this don't allow signing.

NO_USER

Email used for signing not known to GitHub.

OCSP_ERROR

Valid siganture, though certificate revocation check failed.

OCSP_PENDING

Valid signature, pending certificate revocation checking.

OCSP_REVOKED

One or more certificates in chain has been revoked.

UNKNOWN_KEY

Key used for signing not known to GitHub.

UNKNOWN_SIG_TYPE

Unknown signature type.

UNSIGNED

Unsigned.

UNVERIFIED_EMAIL

Email used for signing unverified on GitHub.

VALID

Valid signature and verified by GitHub.


IdentityProviderConfigurationState

The possible states in which authentication can be configured with an identity provider.

Values

CONFIGURED

Authentication with an identity provider is configured but not enforced.

ENFORCED

Authentication with an identity provider is configured and enforced.

UNCONFIGURED

Authentication with an identity provider is not configured.


IpAllowListEnabledSettingValue

The possible values for the IP allow list enabled setting.

Values

DISABLED

The setting is disabled for the owner.

ENABLED

The setting is enabled for the owner.


IpAllowListEntryOrderField

Properties by which IP allow list entry connections can be ordered.

Values

ALLOW_LIST_VALUE

Order IP allow list entries by the allow list value.

CREATED_AT

Order IP allow list entries by creation time.


IssueCommentOrderField

Properties by which issue comment connections can be ordered.

Values

UPDATED_AT

Order issue comments by update time.


IssueOrderField

Properties by which issue connections can be ordered.

Values

COMMENTS

Order issues by comment count.

CREATED_AT

Order issues by creation time.

UPDATED_AT

Order issues by update time.


IssueState

The possible states of an issue.

Values

CLOSED

An issue that has been closed.

OPEN

An issue that is still open.


IssueTimelineItemsItemType

The possible item types found in a timeline.

Values

ADDED_TO_PROJECT_EVENT

Represents aadded_to_projectevent on a given issue or pull request.

ASSIGNED_EVENT

Represents anassignedevent on any assignable object.

CLOSED_EVENT

Represents aclosedevent on any Closable.

COMMENT_DELETED_EVENT

Represents acomment_deletedevent on a given issue or pull request.

CONNECTED_EVENT

Represents aconnectedevent on a given issue or pull request.

CONVERTED_NOTE_TO_ISSUE_EVENT

Represents aconverted_note_to_issueevent on a given issue or pull request.

CROSS_REFERENCED_EVENT

Represents a mention made by one issue or pull request to another.

DEMILESTONED_EVENT

Represents ademilestonedevent on a given issue or pull request.

DISCONNECTED_EVENT

Represents adisconnectedevent on a given issue or pull request.

ISSUE_COMMENT

Represents a comment on an Issue.

LABELED_EVENT

Represents alabeledevent on a given issue or pull request.

LOCKED_EVENT

Represents alockedevent on a given issue or pull request.

MARKED_AS_DUPLICATE_EVENT

Represents amarked_as_duplicateevent on a given issue or pull request.

MENTIONED_EVENT

Represents amentionedevent on a given issue or pull request.

MILESTONED_EVENT

Represents amilestonedevent on a given issue or pull request.

MOVED_COLUMNS_IN_PROJECT_EVENT

Represents amoved_columns_in_projectevent on a given issue or pull request.

PINNED_EVENT

Represents apinnedevent on a given issue or pull request.

REFERENCED_EVENT

Represents areferencedevent on a given ReferencedSubject.

REMOVED_FROM_PROJECT_EVENT

Represents aremoved_from_projectevent on a given issue or pull request.

RENAMED_TITLE_EVENT

Represents arenamedevent on a given issue or pull request.

REOPENED_EVENT

Represents areopenedevent on any Closable.

SUBSCRIBED_EVENT

Represents asubscribedevent on a given Subscribable.

TRANSFERRED_EVENT

Represents atransferredevent on a given issue or pull request.

UNASSIGNED_EVENT

Represents anunassignedevent on any assignable object.

UNLABELED_EVENT

Represents anunlabeledevent on a given issue or pull request.

UNLOCKED_EVENT

Represents anunlockedevent on a given issue or pull request.

UNMARKED_AS_DUPLICATE_EVENT

Represents anunmarked_as_duplicateevent on a given issue or pull request.

UNPINNED_EVENT

Represents anunpinnedevent on a given issue or pull request.

UNSUBSCRIBED_EVENT

Represents anunsubscribedevent on a given Subscribable.

USER_BLOCKED_EVENT

Represents auser_blockedevent on a given user.


LabelOrderField

Properties by which label connections can be ordered.

Values

CREATED_AT

Order labels by creation time.

NAME

Order labels by name.


LanguageOrderField

Properties by which language connections can be ordered.

Values

SIZE

Order languages by the size of all files containing the language.


LockReason

The possible reasons that an issue or pull request was locked.

Values

OFF_TOPIC

The issue or pull request was locked because the conversation was off-topic.

RESOLVED

The issue or pull request was locked because the conversation was resolved.

SPAM

The issue or pull request was locked because the conversation was spam.

TOO_HEATED

The issue or pull request was locked because the conversation was too heated.


MergeStateStatus

Detailed status information about a pull request merge.

Values

BEHIND

The head ref is out of date.

BLOCKED

The merge is blocked.

CLEAN

Mergeable and passing commit status.

DIRTY

The merge commit cannot be cleanly created.

DRAFT

The merge is blocked due to the pull request being a draft.

HAS_HOOKS

Mergeable with passing commit status and pre-receive hooks.

UNKNOWN

The state cannot currently be determined.

UNSTABLE

Mergeable with non-passing commit status.


MergeableState

Whether or not a PullRequest can be merged.

Values

CONFLICTING

The pull request cannot be merged due to merge conflicts.

MERGEABLE

The pull request can be merged.

UNKNOWN

The mergeability of the pull request is still being calculated.


MilestoneOrderField

Properties by which milestone connections can be ordered.

Values

CREATED_AT

Order milestones by when they were created.

DUE_DATE

Order milestones by when they are due.

NUMBER

Order milestones by their number.

UPDATED_AT

Order milestones by when they were last updated.


MilestoneState

The possible states of a milestone.

Values

CLOSED

A milestone that has been closed.

OPEN

A milestone that is still open.


OauthApplicationCreateAuditEntryState

The state of an OAuth Application when it was created.

Values

ACTIVE

The OAuth Application was active and allowed to have OAuth Accesses.

PENDING_DELETION

The OAuth Application was in the process of being deleted.

SUSPENDED

The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns.


OperationType

The corresponding operation type for the action.

Values

ACCESS

An existing resource was accessed.

AUTHENTICATION

A resource performed an authentication event.

CREATE

A new resource was created.

MODIFY

An existing resource was modified.

REMOVE

An existing resource was removed.

RESTORE

An existing resource was restored.

TRANSFER

An existing resource was transferred between multiple resources.


OrderDirection

Possible directions in which to order a list of items when provided an orderBy argument.

Values

ASC

Specifies an ascending order for a given orderBy argument.

DESC

Specifies a descending order for a given orderBy argument.


OrgAddMemberAuditEntryPermission

The permissions available to members on an Organization.

Values

ADMIN

Can read, clone, push, and add collaborators to repositories.

READ

Can read and clone repositories.


OrgCreateAuditEntryBillingPlan

The billing plans available for organizations.

Values

BUSINESS

Team Plan.

BUSINESS_PLUS

Enterprise Cloud Plan.

FREE

Free Plan.

TIERED_PER_SEAT

Tiered Per Seat Plan.

UNLIMITED

Legacy Unlimited Plan.


OrgRemoveBillingManagerAuditEntryReason

The reason a billing manager was removed from an Organization.

Values

SAML_EXTERNAL_IDENTITY_MISSING

SAML external identity missing.

SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY

SAML SSO enforcement requires an external identity.

TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE

The organization required 2FA of its billing managers and this user did not have 2FA enabled.


OrgRemoveMemberAuditEntryMembershipType

The type of membership a user has with an Organization.

Values

ADMIN

Organization administrators have full access and can change several settings, including the names of repositories that belong to the Organization and Owners team membership. In addition, organization admins can delete the organization and all of its repositories.

BILLING_MANAGER

A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.

DIRECT_MEMBER

A direct member is a user that is a member of the Organization.

OUTSIDE_COLLABORATOR

An outside collaborator is a person who isn't explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization.

UNAFFILIATED

An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the Organization.


OrgRemoveMemberAuditEntryReason

The reason a member was removed from an Organization.

Values

SAML_EXTERNAL_IDENTITY_MISSING

SAML external identity missing.

SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY

SAML SSO enforcement requires an external identity.

TWO_FACTOR_ACCOUNT_RECOVERY

User was removed from organization during account recovery.

TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE

The organization required 2FA of its billing managers and this user did not have 2FA enabled.

USER_ACCOUNT_DELETED

User account has been deleted.


OrgRemoveOutsideCollaboratorAuditEntryMembershipType

The type of membership a user has with an Organization.

Values

BILLING_MANAGER

A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.

OUTSIDE_COLLABORATOR

An outside collaborator is a person who isn't explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization.

UNAFFILIATED

An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the organization.


OrgRemoveOutsideCollaboratorAuditEntryReason

The reason an outside collaborator was removed from an Organization.

Values

SAML_EXTERNAL_IDENTITY_MISSING

SAML external identity missing.

TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE

The organization required 2FA of its billing managers and this user did not have 2FA enabled.


OrgUpdateDefaultRepositoryPermissionAuditEntryPermission

The default permission a repository can have in an Organization.

Values

ADMIN

Can read, clone, push, and add collaborators to repositories.

NONE

No default permission value.

READ

Can read and clone repositories.

WRITE

Can read, clone and push to repositories.


OrgUpdateMemberAuditEntryPermission

The permissions available to members on an Organization.

Values

ADMIN

Can read, clone, push, and add collaborators to repositories.

READ

Can read and clone repositories.


OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility

The permissions available for repository creation on an Organization.

Values

ALL

All organization members are restricted from creating any repositories.

INTERNAL

All organization members are restricted from creating internal repositories.

NONE

All organization members are allowed to create any repositories.

PRIVATE

All organization members are restricted from creating private repositories.

PRIVATE_INTERNAL

All organization members are restricted from creating private or internal repositories.

PUBLIC

All organization members are restricted from creating public repositories.

PUBLIC_INTERNAL

All organization members are restricted from creating public or internal repositories.

PUBLIC_PRIVATE

All organization members are restricted from creating public or private repositories.


OrganizationInvitationRole

The possible organization invitation roles.

Values

ADMIN

The user is invited to be an admin of the organization.

BILLING_MANAGER

The user is invited to be a billing manager of the organization.

DIRECT_MEMBER

The user is invited to be a direct member of the organization.

REINSTATE

The user's previous role will be reinstated.


OrganizationInvitationType

The possible organization invitation types.

Values

EMAIL

The invitation was to an email address.

USER

The invitation was to an existing user.


OrganizationMemberRole

The possible roles within an organization for its members.

Values

ADMIN

The user is an administrator of the organization.

MEMBER

The user is a member of the organization.


OrganizationMembersCanCreateRepositoriesSettingValue

The possible values for the members can create repositories setting on an organization.

Values

ALL

Members will be able to create public and private repositories.

DISABLED

Members will not be able to create public or private repositories.

PRIVATE

Members will be able to create only private repositories.


OrganizationOrderField

Properties by which organization connections can be ordered.

Values

CREATED_AT

Order organizations by creation time.

LOGIN

Order organizations by login.


PackageFileOrderField

Properties by which package file connections can be ordered.

Values

CREATED_AT

Order package files by creation time.


PackageOrderField

Properties by which package connections can be ordered.

Values

CREATED_AT

Order packages by creation time.


PackageType

The possible types of a package.

Values

DEBIAN

A debian package.

DOCKER

A docker image.

MAVEN

A maven package.

NPM

An npm package.

NUGET

A nuget package.

PYPI

A python package.

RUBYGEMS

A rubygems package.


PackageVersionOrderField

Properties by which package version connections can be ordered.

Values

CREATED_AT

Order package versions by creation time.


PinnableItemType

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

Values

GIST

A gist.

ISSUE

An issue.

ORGANIZATION

An organization.

PROJECT

A project.

PULL_REQUEST

A pull request.

REPOSITORY

A repository.

TEAM

A team.

USER

A user.


ProjectCardArchivedState

The possible archived states of a project card.

Values

ARCHIVED

A project card that is archived.

NOT_ARCHIVED

A project card that is not archived.


ProjectCardState

Various content states of a ProjectCard.

Values

CONTENT_ONLY

The card has content only.

NOTE_ONLY

The card has a note only.

REDACTED

The card is redacted.


ProjectColumnPurpose

The semantic purpose of the column - todo, in progress, or done.

Values

DONE

The column contains cards which are complete.

IN_PROGRESS

The column contains cards which are currently being worked on.

TODO

The column contains cards still to be worked on.


ProjectOrderField

Properties by which project connections can be ordered.

Values

CREATED_AT

Order projects by creation time.

NAME

Order projects by name.

UPDATED_AT

Order projects by update time.


ProjectState

State of the project; eitheropenor 'closed'.

Values

CLOSED

The project is closed.

OPEN

The project is open.


ProjectTemplate

GitHub-provided templates for Projects.

Values

AUTOMATED_KANBAN_V2

Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.

AUTOMATED_REVIEWS_KANBAN

Create a board with triggers to automatically move cards across columns with review automation.

BASIC_KANBAN

Create a board with columns for To do, In progress and Done.

BUG_TRIAGE

Create a board to triage and prioritize bugs with To do, priority, and Done columns.


PullRequestMergeMethod

Represents available types of methods to use when merging a pull request.

Values

MERGE

Add all commits from the head branch to the base branch with a merge commit.

REBASE

Add all commits from the head branch onto the base branch individually.

SQUASH

Combine all commits from the head branch into a single commit in the base branch.


PullRequestOrderField

Properties by which pull_requests connections can be ordered.

Values

CREATED_AT

Order pull_requests by creation time.

UPDATED_AT

Order pull_requests by update time.


PullRequestReviewCommentState

The possible states of a pull request review comment.

Values

PENDING

A comment that is part of a pending review.

SUBMITTED

A comment that is part of a submitted review.


PullRequestReviewDecision

The review status of a pull request.

Values

APPROVED

The pull request has received an approving review.

CHANGES_REQUESTED

Changes have been requested on the pull request.

REVIEW_REQUIRED

A review is required before the pull request can be merged.


PullRequestReviewEvent

The possible events to perform on a pull request review.

Values

APPROVE

Submit feedback and approve merging these changes.

COMMENT

Submit general feedback without explicit approval.

DISMISS

Dismiss review so it now longer effects merging.

REQUEST_CHANGES

Submit feedback that must be addressed before merging.


PullRequestReviewState

The possible states of a pull request review.

Values

APPROVED

A review allowing the pull request to merge.

CHANGES_REQUESTED

A review blocking the pull request from merging.

COMMENTED

An informational review.

DISMISSED

A review that has been dismissed.

PENDING

A review that has not yet been submitted.


PullRequestState

The possible states of a pull request.

Values

CLOSED

A pull request that has been closed without being merged.

MERGED

A pull request that has been closed by being merged.

OPEN

A pull request that is still open.


PullRequestTimelineItemsItemType

The possible item types found in a timeline.

Values

ADDED_TO_PROJECT_EVENT

Represents aadded_to_projectevent on a given issue or pull request.

ASSIGNED_EVENT

Represents anassignedevent on any assignable object.

AUTOMATIC_BASE_CHANGE_FAILED_EVENT

Represents aautomatic_base_change_failedevent on a given pull request.

AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT

Represents aautomatic_base_change_succeededevent on a given pull request.

BASE_REF_CHANGED_EVENT

Represents abase_ref_changedevent on a given issue or pull request.

BASE_REF_DELETED_EVENT

Represents abase_ref_deletedevent on a given pull request.

BASE_REF_FORCE_PUSHED_EVENT

Represents abase_ref_force_pushedevent on a given pull request.

CLOSED_EVENT

Represents aclosedevent on any Closable.

COMMENT_DELETED_EVENT

Represents acomment_deletedevent on a given issue or pull request.

CONNECTED_EVENT

Represents aconnectedevent on a given issue or pull request.

CONVERTED_NOTE_TO_ISSUE_EVENT

Represents aconverted_note_to_issueevent on a given issue or pull request.

CONVERT_TO_DRAFT_EVENT

Represents aconvert_to_draftevent on a given pull request.

CROSS_REFERENCED_EVENT

Represents a mention made by one issue or pull request to another.

DEMILESTONED_EVENT

Represents ademilestonedevent on a given issue or pull request.

DEPLOYED_EVENT

Represents adeployedevent on a given pull request.

DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT

Represents adeployment_environment_changedevent on a given pull request.

DISCONNECTED_EVENT

Represents adisconnectedevent on a given issue or pull request.

HEAD_REF_DELETED_EVENT

Represents ahead_ref_deletedevent on a given pull request.

HEAD_REF_FORCE_PUSHED_EVENT

Represents ahead_ref_force_pushedevent on a given pull request.

HEAD_REF_RESTORED_EVENT

Represents ahead_ref_restoredevent on a given pull request.

ISSUE_COMMENT

Represents a comment on an Issue.

LABELED_EVENT

Represents alabeledevent on a given issue or pull request.

LOCKED_EVENT

Represents alockedevent on a given issue or pull request.

MARKED_AS_DUPLICATE_EVENT

Represents amarked_as_duplicateevent on a given issue or pull request.

MENTIONED_EVENT

Represents amentionedevent on a given issue or pull request.

MERGED_EVENT

Represents amergedevent on a given pull request.

MILESTONED_EVENT

Represents amilestonedevent on a given issue or pull request.

MOVED_COLUMNS_IN_PROJECT_EVENT

Represents amoved_columns_in_projectevent on a given issue or pull request.

PINNED_EVENT

Represents apinnedevent on a given issue or pull request.

PULL_REQUEST_COMMIT

Represents a Git commit part of a pull request.

PULL_REQUEST_COMMIT_COMMENT_THREAD

Represents a commit comment thread part of a pull request.

PULL_REQUEST_REVIEW

A review object for a given pull request.

PULL_REQUEST_REVIEW_THREAD

A threaded list of comments for a given pull request.

PULL_REQUEST_REVISION_MARKER

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

READY_FOR_REVIEW_EVENT

Represents aready_for_reviewevent on a given pull request.

REFERENCED_EVENT

Represents areferencedevent on a given ReferencedSubject.

REMOVED_FROM_PROJECT_EVENT

Represents aremoved_from_projectevent on a given issue or pull request.

RENAMED_TITLE_EVENT

Represents arenamedevent on a given issue or pull request.

REOPENED_EVENT

Represents areopenedevent on any Closable.

REVIEW_DISMISSED_EVENT

Represents areview_dismissedevent on a given issue or pull request.

REVIEW_REQUESTED_EVENT

Represents anreview_requestedevent on a given pull request.

REVIEW_REQUEST_REMOVED_EVENT

Represents anreview_request_removedevent on a given pull request.

SUBSCRIBED_EVENT

Represents asubscribedevent on a given Subscribable.

TRANSFERRED_EVENT

Represents atransferredevent on a given issue or pull request.

UNASSIGNED_EVENT

Represents anunassignedevent on any assignable object.

UNLABELED_EVENT

Represents anunlabeledevent on a given issue or pull request.

UNLOCKED_EVENT

Represents anunlockedevent on a given issue or pull request.

UNMARKED_AS_DUPLICATE_EVENT

Represents anunmarked_as_duplicateevent on a given issue or pull request.

UNPINNED_EVENT

Represents anunpinnedevent on a given issue or pull request.

UNSUBSCRIBED_EVENT

Represents anunsubscribedevent on a given Subscribable.

USER_BLOCKED_EVENT

Represents auser_blockedevent on a given user.


PullRequestUpdateState

The possible target states when updating a pull request.

Values

CLOSED

A pull request that has been closed without being merged.

OPEN

A pull request that is still open.


ReactionContent

Emojis that can be attached to Issues, Pull Requests and Comments.

Values

CONFUSED

Represents the :confused: emoji.

EYES

Represents the :eyes: emoji.

HEART

Represents the :heart: emoji.

HOORAY

Represents the :hooray: emoji.

LAUGH

Represents the :laugh: emoji.

ROCKET

Represents the :rocket: emoji.

THUMBS_DOWN

Represents the :-1: emoji.

THUMBS_UP

Represents the :+1: emoji.


ReactionOrderField

A list of fields that reactions can be ordered by.

Values

CREATED_AT

Allows ordering a list of reactions by when they were created.


RefOrderField

Properties by which ref connections can be ordered.

Values

ALPHABETICAL

Order refs by their alphanumeric name.

TAG_COMMIT_DATE

Order refs by underlying commit date if the ref prefix is refs/tags/.


ReleaseOrderField

Properties by which release connections can be ordered.

Values

CREATED_AT

Order releases by creation time.

NAME

Order releases alphabetically by name.


RepoAccessAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RepoAddMemberAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RepoArchivedAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RepoChangeMergeSettingAuditEntryMergeType

The merge options available for pull requests to this repository.

Values

MERGE

The pull request is added to the base branch in a merge commit.

REBASE

Commits from the pull request are added onto the base branch individually without a merge commit.

SQUASH

The pull request's commits are squashed into a single commit before they are merged to the base branch.


RepoCreateAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RepoDestroyAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RepoRemoveMemberAuditEntryVisibility

The privacy of a repository.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


ReportedContentClassifiers

The reasons a piece of content can be reported or minimized.

Values

ABUSE

An abusive or harassing piece of content.

DUPLICATE

A duplicated piece of content.

OFF_TOPIC

An irrelevant piece of content.

OUTDATED

An outdated piece of content.

RESOLVED

The content has been resolved.

SPAM

A spammy piece of content.


RepositoryAffiliation

The affiliation of a user to a repository.

Values

COLLABORATOR

Repositories that the user has been added to as a collaborator.

ORGANIZATION_MEMBER

Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

OWNER

Repositories that are owned by the authenticated user.


RepositoryContributionType

The reason a repository is listed as 'contributed'.

Values

COMMIT

Created a commit.

ISSUE

Created an issue.

PULL_REQUEST

Created a pull request.

PULL_REQUEST_REVIEW

Reviewed a pull request.

REPOSITORY

Created the repository.


RepositoryInteractionLimit

A repository interaction limit.

Values

COLLABORATORS_ONLY

Users that are not collaborators will not be able to interact with the repository.

CONTRIBUTORS_ONLY

Users that have not previously committed to a repository’s default branch will be unable to interact with the repository.

EXISTING_USERS

Users that have recently created their account will be unable to interact with the repository.

NO_LIMIT

No interaction limits are enabled.


RepositoryInteractionLimitExpiry

The length for a repository interaction limit to be enabled for.

Values

ONE_DAY

The interaction limit will expire after 1 day.

ONE_MONTH

The interaction limit will expire after 1 month.

ONE_WEEK

The interaction limit will expire after 1 week.

SIX_MONTHS

The interaction limit will expire after 6 months.

THREE_DAYS

The interaction limit will expire after 3 days.


RepositoryInteractionLimitOrigin

Indicates where an interaction limit is configured.

Values

ORGANIZATION

A limit that is configured at the organization level.

REPOSITORY

A limit that is configured at the repository level.

USER

A limit that is configured at the user-wide level.


RepositoryInvitationOrderField

Properties by which repository invitation connections can be ordered.

Values

CREATED_AT

Order repository invitations by creation time.

INVITEE_LOGIN

Order repository invitations by invitee login.


RepositoryLockReason

The possible reasons a given repository could be in a locked state.

Values

BILLING

The repository is locked due to a billing related reason.

MIGRATING

The repository is locked due to a migration.

MOVING

The repository is locked due to a move.

RENAME

The repository is locked due to a rename.


RepositoryOrderField

Properties by which repository connections can be ordered.

Values

CREATED_AT

Order repositories by creation time.

NAME

Order repositories by name.

PUSHED_AT

Order repositories by push time.

STARGAZERS

Order repositories by number of stargazers.

UPDATED_AT

Order repositories by update time.


RepositoryPermission

The access level to a repository.

Values

ADMIN

Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators.

MAINTAIN

Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings.

READ

Can read and clone this repository. Can also open and comment on issues and pull requests.

TRIAGE

Can read and clone this repository. Can also manage issues and pull requests.

WRITE

Can read, clone, and push to this repository. Can also manage issues and pull requests.


RepositoryPrivacy

The privacy of a repository.

Values

PRIVATE

Private.

PUBLIC

Public.


RepositoryVisibility

The repository's visibility level.

Values

INTERNAL

The repository is visible only to users in the same business.

PRIVATE

The repository is visible only to those with explicit access.

PUBLIC

The repository is visible to everyone.


RequestableCheckStatusState

The possible states that can be requested when creating a check run.

Values

COMPLETED

The check suite or run has been completed.

IN_PROGRESS

The check suite or run is in progress.

QUEUED

The check suite or run has been queued.


SamlDigestAlgorithm

The possible digest algorithms used to sign SAML requests for an identity provider.

Values

SHA1

SHA1.

SHA256

SHA256.

SHA384

SHA384.

SHA512

SHA512.


SamlSignatureAlgorithm

The possible signature algorithms used to sign SAML requests for a Identity Provider.

Values

RSA_SHA1

RSA-SHA1.

RSA_SHA256

RSA-SHA256.

RSA_SHA384

RSA-SHA384.

RSA_SHA512

RSA-SHA512.


SavedReplyOrderField

Properties by which saved reply connections can be ordered.

Values

UPDATED_AT

Order saved reply by when they were updated.


SearchType

Represents the individual results of a search.

Values

ISSUE

Returns results matching issues in repositories.

REPOSITORY

Returns results matching repositories.

USER

Returns results matching users and organizations on GitHub.


SecurityAdvisoryEcosystem

The possible ecosystems of a security vulnerability's package.

Values

COMPOSER

PHP packages hosted at packagist.org.

MAVEN

Java artifacts hosted at the Maven central repository.

NPM

JavaScript packages hosted at npmjs.com.

NUGET

.NET packages hosted at the NuGet Gallery.

PIP

Python packages hosted at PyPI.org.

RUBYGEMS

Ruby gems hosted at RubyGems.org.


SecurityAdvisoryIdentifierType

Identifier formats available for advisories.

Values

CVE

Common Vulnerabilities and Exposures Identifier.

GHSA

GitHub Security Advisory ID.


SecurityAdvisoryOrderField

Properties by which security advisory connections can be ordered.

Values

PUBLISHED_AT

Order advisories by publication time.

UPDATED_AT

Order advisories by update time.


SecurityAdvisorySeverity

Severity of the vulnerability.

Values

CRITICAL

Critical.

HIGH

High.

LOW

Low.

MODERATE

Moderate.


SecurityVulnerabilityOrderField

Properties by which security vulnerability connections can be ordered.

Values

UPDATED_AT

Order vulnerability by update time.


SponsorsTierOrderField

Properties by which Sponsors tiers connections can be ordered.

Values

CREATED_AT

Order tiers by creation time.

MONTHLY_PRICE_IN_CENTS

Order tiers by their monthly price in cents.


SponsorshipOrderField

Properties by which sponsorship connections can be ordered.

Values

CREATED_AT

Order sponsorship by creation time.


SponsorshipPrivacy

The privacy of a sponsorship.

Values

PRIVATE

Private.

PUBLIC

Public.


StarOrderField

Properties by which star connections can be ordered.

Values

STARRED_AT

Allows ordering a list of stars by when they were created.


StatusState

The possible commit status states.

Values

ERROR

Status is errored.

EXPECTED

Status is expected.

FAILURE

Status is failing.

PENDING

Status is pending.

SUCCESS

Status is successful.


SubscriptionState

The possible states of a subscription.

Values

IGNORED

The User is never notified.

SUBSCRIBED

The User is notified of all conversations.

UNSUBSCRIBED

The User is only notified when participating or @mentioned.


TeamDiscussionCommentOrderField

Properties by which team discussion comment connections can be ordered.

Values

NUMBER

Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).


TeamDiscussionOrderField

Properties by which team discussion connections can be ordered.

Values

CREATED_AT

Allows chronological ordering of team discussions.


TeamMemberOrderField

Properties by which team member connections can be ordered.

Values

CREATED_AT

Order team members by creation time.

LOGIN

Order team members by login.


TeamMemberRole

The possible team member roles; eithermaintaineror 'member'.

Values

MAINTAINER

A team maintainer has permission to add and remove team members.

MEMBER

A team member has no administrative permissions on the team.


TeamMembershipType

Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.

Values

ALL

Includes immediate and child team members for the team.

CHILD_TEAM

Includes only child team members for the team.

IMMEDIATE

Includes only immediate members of the team.


TeamOrderField

Properties by which team connections can be ordered.

Values

NAME

Allows ordering a list of teams by name.


TeamPrivacy

The possible team privacy values.

Values

SECRET

A secret team can only be seen by its members.

VISIBLE

A visible team can be seen and @mentioned by every member of the organization.


TeamRepositoryOrderField

Properties by which team repository connections can be ordered.

Values

CREATED_AT

Order repositories by creation time.

NAME

Order repositories by name.

PERMISSION

Order repositories by permission.

PUSHED_AT

Order repositories by push time.

STARGAZERS

Order repositories by number of stargazers.

UPDATED_AT

Order repositories by update time.


TeamReviewAssignmentAlgorithm

The possible team review assignment algorithms.

Preview notice

TeamReviewAssignmentAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

Values

LOAD_BALANCE

Balance review load across the entire team.

ROUND_ROBIN

Alternate reviews between each team member.


TeamRole

The role of a user on a team.

Values

ADMIN

User has admin rights on the team.

MEMBER

User is a member of the team.


TopicSuggestionDeclineReason

Reason that the suggested topic is declined.

Values

NOT_RELEVANT

The suggested topic is not relevant to the repository.

PERSONAL_PREFERENCE

The viewer does not like the suggested topic.

TOO_GENERAL

The suggested topic is too general for the repository.

TOO_SPECIFIC

The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1).


UserBlockDuration

The possible durations that a user can be blocked for.

Values

ONE_DAY

The user was blocked for 1 day.

ONE_MONTH

The user was blocked for 30 days.

ONE_WEEK

The user was blocked for 7 days.

PERMANENT

The user was blocked permanently.

THREE_DAYS

The user was blocked for 3 days.


UserStatusOrderField

Properties by which user status connections can be ordered.

Values

UPDATED_AT

Order user statuses by when they were updated.


Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.