Github API - Test Config

SponsorsListing [object]

A GitHub Sponsors listing.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
activeGoal SponsorsGoal

SponsorsGoal [object]

A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

Attributes
description String

A description of the goal from the maintainer.

What the objective of this goal is.

percentComplete Int

The percentage representing how complete this goal is, between 0-100.

targetValue Int

What the goal amount is. Represents an amount in USD for monthly sponsorship
amount goals. Represents a count of unique sponsors for total sponsors count goals.

title String

A brief summary of the kind and target value of this goal.

API:
Github GraphQL API

The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

activeStripeConnectAccount StripeConnectAccount

StripeConnectAccount [object]

A Stripe Connect account for receiving sponsorship funds from GitHub Sponsors.

Attributes
accountId String

The account number used to identify this Stripe Connect account.

billingCountryOrRegion String

The name of the country or region of an external account, such as a bank
account, tied to the Stripe Connect account. Will only return a value when
queried by the maintainer of the associated GitHub Sponsors profile
themselves, or by an admin of the sponsorable organization.

countryOrRegion String

The name of the country or region of the Stripe Connect account. Will only
return a value when queried by the maintainer of the associated GitHub
Sponsors profile themselves, or by an admin of the sponsorable organization.

isActive Boolean

Whether this Stripe Connect account is currently in use for the associated GitHub Sponsors profile.

sponsorsListing SponsorsListing

The GitHub Sponsors profile associated with this Stripe Connect account.

stripeDashboardUrl URI

The URL to access this Stripe Connect account on Stripe's website.

API:
Github GraphQL API

The Stripe Connect account currently in use for payouts for this Sponsors
listing, if any. Will only return a value when queried by the maintainer
themselves, or by an admin of the sponsorable organization.

billingCountryOrRegion String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The name of the country or region with the maintainer's bank account or fiscal
host. Will only return a value when queried by the maintainer themselves, or
by an admin of the sponsorable organization.

contactEmailAddress String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The email address used by GitHub to contact the sponsorable about their GitHub
Sponsors profile. Will only return a value when queried by the maintainer
themselves, or by an admin of the sponsorable organization.

createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was created.

dashboardResourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for the Sponsors dashboard for this Sponsors listing.

dashboardUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for the Sponsors dashboard for this Sponsors listing.

featuredItems SponsorsListingFeaturedItem []

SponsorsListingFeaturedItem [object]

A record that is promoted on a GitHub Sponsors profile.

Implements
Node
Attributes
createdAt DateTime

Identifies the date and time when the object was created.

description String

Will either be a description from the sponsorable maintainer about why they
featured this item, or the item's description itself, such as a user's bio
from their GitHub profile page.

The record that is featured on the GitHub Sponsors profile.

id ID

The Node ID of the SponsorsListingFeaturedItem object

position Int

The position of this featured item on the GitHub Sponsors profile with a lower
position indicating higher precedence. Starts at 1.

sponsorsListing SponsorsListing

The GitHub Sponsors profile that features this record.

updatedAt DateTime

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

API:
Github GraphQL API

The records featured on the GitHub Sponsors profile.

fiscalHost Organization

Organization [object]

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

Implements
ActorAnnouncementBannerMemberStatusableNodePackageOwnerProfileOwnerProjectOwnerProjectV2OwnerProjectV2RecentRepositoryDiscussionAuthorRepositoryDiscussionCommentAuthorRepositoryOwnerSponsorableUniformResourceLocatable
Attributes
announcement String

The text of the announcement

announcementExpiresAt DateTime

The expiration date of the announcement, if any

announcementUserDismissible Boolean

Whether the announcement can be dismissed by the user

anyPinnableItems Boolean

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

archivedAt DateTime

Identifies the date and time when the organization was archived.

Audit log entries of the organization

avatarUrl URI

A URL pointing to the organization's public avatar.

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

description String

The organization's public profile description.

descriptionHTML String

The organization's public profile description rendered to HTML.

A list of domains owned by the organization.

email String

The organization's public email.

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

estimatedNextSponsorsPayoutInCents Int

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

hasSponsorsListing Boolean

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

id ID

The Node ID of the Organization object

interactionAbility RepositoryInteractionAbility

The interaction ability settings for this organization.

ipAllowListEnabledSetting IpAllowListEnabledSettingValue

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

ipAllowListEntries IpAllowListEntryConnection

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

ipAllowListForInstalledAppsEnabledSetting IpAllowListForInstalledAppsEnabledSettingValue

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

isSponsoredBy Boolean

Whether the given account is sponsoring this user/organization.

isSponsoringViewer Boolean

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

isVerified Boolean

Whether the organization has verified its profile email and website.

itemShowcase ProfileItemShowcase

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

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

location String

The organization's public profile location.

login String

The organization's login name.

mannequins MannequinConnection

A list of all mannequins for this organization.

memberStatuses UserStatusConnection

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

membersCanForkPrivateRepositories Boolean

Members can fork private repositories in this organization

A list of users who are members of this organization.

monthlyEstimatedSponsorsIncomeInCents Int

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

name String

The organization's public profile name.

newTeamResourcePath URI

The HTTP path creating a new team

newTeamUrl URI

The HTTP URL creating a new team

notificationDeliveryRestrictionEnabledSetting NotificationRestrictionSettingValue

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

organizationBillingEmail String

The billing email for the organization.

A list of packages under the owner.

pendingMembers UserConnection

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

pinnableItems PinnableItemConnection

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

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

pinnedItemsRemaining Int

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.

A list of projects under the owner.

projectsResourcePath URI

The HTTP path listing organization's projects

projectsUrl URI

The HTTP URL listing organization's projects

projectsV2 ProjectV2Connection

A list of projects under the owner.

recentProjects ProjectV2Connection

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

repositories RepositoryConnection

A list of repositories that the user owns.

repository Repository

Find Repository.

repositoryDiscussionComments DiscussionCommentConnection

Discussion comments this user has authored.

repositoryDiscussions DiscussionConnection

Discussions this user has started.

repositoryMigrations RepositoryMigrationConnection

A list of all repository migrations for this organization.

requiresTwoFactorAuthentication Boolean

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

resourcePath URI

The HTTP path for this organization.

Returns a single ruleset from the current organization by ID.

A list of rulesets for this organization.

samlIdentityProvider OrganizationIdentityProvider

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 SponsorConnection

List of users and organizations this entity is sponsoring.

List of sponsors for this user or organization.

sponsorsActivities SponsorsActivityConnection

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

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer SponsorshipConnection

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

sponsorshipsAsSponsor SponsorshipConnection

The sponsorships where this user or organization is the funder.

team Team

Find an organization's team by its slug.

A list of teams in this organization.

teamsResourcePath URI

The HTTP path listing organization's teams

teamsUrl URI

The HTTP URL listing organization's teams

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 organization's Twitter username.

updatedAt DateTime

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

url URI

The HTTP URL for this organization.

viewerCanAdminister Boolean

Organization is adminable by the viewer.

viewerCanChangePinnedItems Boolean

Can the viewer pin repositories and gists to the profile?

viewerCanCreateProjects Boolean

Can the current viewer create new projects on this owner.

viewerCanCreateRepositories Boolean

Viewer can create repositories on this organization

viewerCanCreateTeams Boolean

Viewer can create teams on this organization.

viewerCanSponsor Boolean

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

viewerIsAMember Boolean

Viewer is an active member of this organization.

viewerIsFollowing Boolean

Whether or not this Organization is followed by the viewer.

viewerIsSponsoring Boolean

True if the viewer is sponsoring this user/organization.

webCommitSignoffRequired Boolean

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

websiteUrl URI

The organization's public profile URL.

API:
Github GraphQL API

The fiscal host used for payments, if any. Will only return a value when
queried by the maintainer themselves, or by an admin of the sponsorable organization.

fullDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The full description of the listing.

fullDescriptionHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The full description of the listing rendered to HTML.

id ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The Node ID of the SponsorsListing object

isPublic Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing is publicly visible.

name String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's full name.

nextPayoutDate Date

Date [scalar]

An ISO-8601 encoded date string.

API:
Github GraphQL API

A future date on which this listing is eligible to receive a payout.

residenceCountryOrRegion String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The name of the country or region where the maintainer resides. Will only
return a value when queried by the maintainer themselves, or by an admin of
the sponsorable organization.

resourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for this Sponsors listing.

shortDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The short description of the listing.

slug String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The short name of the listing.

sponsorable Sponsorable

Sponsorable [interface]

Entities that can sponsor or be sponsored through GitHub Sponsors.

Attributes
estimatedNextSponsorsPayoutInCents Int

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

hasSponsorsListing Boolean

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

isSponsoredBy Boolean

Whether the given account is sponsoring this user/organization.

isSponsoringViewer Boolean

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

lifetimeReceivedSponsorshipValues SponsorAndLifetimeValueConnection

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

monthlyEstimatedSponsorsIncomeInCents Int

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

sponsoring SponsorConnection

List of users and organizations this entity is sponsoring.

List of sponsors for this user or organization.

sponsorsActivities SponsorsActivityConnection

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

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer SponsorshipConnection

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

sponsorshipsAsSponsor SponsorshipConnection

The sponsorships where this user or organization is the funder.

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.

viewerCanSponsor Boolean

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

viewerIsSponsoring Boolean

True if the viewer is sponsoring this user/organization.

API:
Github GraphQL API

The entity this listing represents who can be sponsored on GitHub Sponsors.

tiers SponsorsTierConnection

SponsorsTierConnection [object]

The connection type for SponsorsTier.

Attributes
edges SponsorsTierEdge []

A list of edges.

nodes SponsorsTier []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

The tiers for this GitHub Sponsors profile.

url URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for this Sponsors listing.

API:
Github GraphQL API