Magidoc

Organization
Object

An account on GitHub, with one or more owners, that has repositories, members and teams.

Fields

#

announcement

The text of the announcement

announcementCreatedAt

The date the announcement was created

announcementExpiresAt

The expiration date of the announcement, if any

announcementUserDismissible

Whether the announcement can be dismissed by the user

anyPinnableItems

Non-null

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

archivedAt

Identifies the date and time when the organization was archived.

auditLog

Non-null

Audit log entries of the organization

avatarUrl

Non-null

A URL pointing to the organization's public avatar.

createdAt

Non-null

Identifies the date and time when the object was created.

databaseId

Identifies the primary key from the database.

description

The organization's public profile description.

descriptionHTML

The organization's public profile description rendered to HTML.

domains

A list of domains owned by the organization.

email

The organization's public email.

enterpriseOwners

Non-null

A list of owners of the organization's enterprise account.

estimatedNextSponsorsPayoutInCents

Non-null

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

hasSponsorsListing

Non-null

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

id

ID !
Non-null

The Node ID of the Organization object

interactionAbility

The interaction ability settings for this organization.

ipAllowListEnabledSetting

Non-null

The setting value for whether the organization has an IP allow list enabled.

ipAllowListEntries

Non-null

The IP addresses that are allowed to access resources owned by the organization.

ipAllowListForInstalledAppsEnabledSetting

Non-null

The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.

isSponsoredBy

Non-null

Whether the given account is sponsoring this user/organization.

isSponsoringViewer

Non-null

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

isVerified

Non-null

Whether the organization has verified its profile email and website.

itemShowcase

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

Non-null

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

location

The organization's public profile location.

login

Non-null

The organization's login name.

mannequins

Non-null

A list of all mannequins for this organization.

memberStatuses

Non-null

Get the status messages members of this entity have set that are either public or visible only to the organization.

membersCanForkPrivateRepositories

Non-null

Members can fork private repositories in this organization

membersWithRole

Non-null

A list of users who are members of this organization.

monthlyEstimatedSponsorsIncomeInCents

Non-null

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

name

The organization's public profile name.

newTeamResourcePath

Non-null

The HTTP path creating a new team

newTeamUrl

Non-null

The HTTP URL creating a new team

notificationDeliveryRestrictionEnabledSetting

Non-null

Indicates if email notification delivery for this organization is restricted to verified or approved domains.

organizationBillingEmail

The billing email for the organization.

packages

Non-null

A list of packages under the owner.

pendingMembers

Non-null

A list of users who have been invited to join this organization.

pinnableItems

Non-null

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

pinnedItems

Non-null

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

pinnedItemsRemaining

Non-null

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

project

Find project by number.

projectV2

Find a project by number.

projects

Non-null

A list of projects under the owner.

projectsResourcePath

Non-null

The HTTP path listing organization's projects

projectsUrl

Non-null

The HTTP URL listing organization's projects

projectsV2

Non-null

A list of projects under the owner.

recentProjects

Non-null

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

repositories

Non-null

A list of repositories that the user owns.

repository

Find Repository.

repositoryDiscussionComments

Non-null

Discussion comments this user has authored.

repositoryDiscussions

Non-null

Discussions this user has started.

repositoryMigrations

Non-null

A list of all repository migrations for this organization.

requiresTwoFactorAuthentication

When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

resourcePath

Non-null

The HTTP path for this organization.

ruleset

Returns a single ruleset from the current organization by ID.

rulesets

A list of rulesets for this organization.

samlIdentityProvider

The Organization's SAML identity provider. Visible to (1) organization owners, (2) organization owners' personal access tokens (classic) with read:org or admin:org scope, (3) GitHub App with an installation token with read or write access to members.

sponsoring

Non-null

List of users and organizations this entity is sponsoring.

sponsors

Non-null

List of sponsors for this user or organization.

sponsorsActivities

Non-null

Events involving this sponsorable, such as new sponsorships.

sponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor

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

sponsorshipForViewerAsSponsorable

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

sponsorshipNewsletters

Non-null

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer

Non-null

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

sponsorshipsAsSponsor

Non-null

The sponsorships where this user or organization is the funder.

team

Find an organization's team by its slug.

teams

Non-null

A list of teams in this organization.

teamsResourcePath

Non-null

The HTTP path listing organization's teams

teamsUrl

Non-null

The HTTP URL listing organization's teams

totalSponsorshipAmountAsSponsorInCents

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

The organization's Twitter username.

updatedAt

Non-null

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

url

Non-null

The HTTP URL for this organization.

viewerCanAdminister

Non-null

Organization is adminable by the viewer.

viewerCanChangePinnedItems

Non-null

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects

Non-null

Can the current viewer create new projects on this owner.

viewerCanCreateRepositories

Non-null

Viewer can create repositories on this organization

viewerCanCreateTeams

Non-null

Viewer can create teams on this organization.

viewerCanSponsor

Non-null

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

viewerIsAMember

Non-null

Viewer is an active member of this organization.

viewerIsFollowing

Non-null

Whether or not this Organization is followed by the viewer.

viewerIsSponsoring

Non-null

True if the viewer is sponsoring this user/organization.

webCommitSignoffRequired

Non-null

Whether contributors are required to sign off on web-based commits for repositories in this organization.

websiteUrl

The organization's public profile URL.

Interfaces

#

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

Usages

#

References

#