SponsorsListing [object]
A GitHub Sponsors listing.
Implements
Attributes
SponsorsGoal [object]
A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.
Attributes
A description of the goal from the maintainer.
What the objective of this goal is.
The percentage representing how complete this goal is, between 0-100.
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.
A brief summary of the kind and target value of this goal.
The current goal the maintainer is trying to reach with GitHub Sponsors, if any.
StripeConnectAccount [object]
A Stripe Connect account for receiving sponsorship funds from GitHub Sponsors.
Attributes
The account number used to identify this Stripe Connect account.
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.
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.
Whether this Stripe Connect account is currently in use for the associated GitHub Sponsors profile.
The GitHub Sponsors profile associated with this Stripe Connect account.
The URL to access this Stripe Connect account on Stripe's website.
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.
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.
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.
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.
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.
Identifies the date and time when the object was created.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for the Sponsors dashboard for this Sponsors listing.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for the Sponsors dashboard for this Sponsors listing.
SponsorsListingFeaturedItem [object]
A record that is promoted on a GitHub Sponsors profile.
Implements
Attributes
Identifies the date and time when the object was created.
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.
The Node ID of the SponsorsListingFeaturedItem object
The position of this featured item on the GitHub Sponsors profile with a lower
position indicating higher precedence. Starts at 1.
The GitHub Sponsors profile that features this record.
Identifies the date and time when the object was last updated.
The records featured on the GitHub Sponsors profile.
Organization [object]
An account on GitHub, with one or more owners, that has repositories, members and teams.
Implements
Attributes
The text of the announcement
The expiration date of the announcement, if any
Whether the announcement can be dismissed by the user
Determine if this repository owner has any items that can be pinned to their profile.
Identifies the date and time when the organization was archived.
Audit log entries of the organization
A URL pointing to the organization's public avatar.
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The organization's public profile description.
The organization's public profile description rendered to HTML.
A list of domains owned by the organization.
The organization's public email.
A list of owners of the organization's enterprise account.
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
True if this user/organization has a GitHub Sponsors listing.
The Node ID of the Organization object
The interaction ability settings for this organization.
The setting value for whether the organization has an IP allow list enabled.
The IP addresses that are allowed to access resources owned by the organization.
The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.
Whether the given account is sponsoring this user/organization.
True if the viewer is sponsored by this user/organization.
Whether the organization has verified its profile email and website.
Showcases a selection of repositories and gists that the profile owner has
either curated or that have been selected automatically based on popularity.
Calculate how much each sponsor has ever paid total to this maintainer via
GitHub Sponsors. Does not include sponsorships paid via Patreon.
The organization's public profile location.
The organization's login name.
A list of all mannequins for this organization.
Get the status messages members of this entity have set that are either public or visible only to the organization.
Members can fork private repositories in this organization
A list of users who are members of this organization.
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
The organization's public profile name.
The HTTP path creating a new team
The HTTP URL creating a new team
Indicates if email notification delivery for this organization is restricted to verified or approved domains.
The billing email for the organization.
A list of packages under the owner.
A list of users who have been invited to join this organization.
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
Returns how many more items this profile owner can pin to their profile.
Find project by number.
Find a project by number.
A list of projects under the owner.
The HTTP path listing organization's projects
The HTTP URL listing organization's projects
A list of projects under the owner.
Recent projects that this user has modified in the context of the owner.
A list of repositories that the user owns.
Find Repository.
Discussion comments this user has authored.
Discussions this user has started.
A list of all repository migrations for this organization.
When true the organization requires all members, billing managers, and outside
collaborators to enable two-factor authentication.
The HTTP path for this organization.
Returns a single ruleset from the current organization by ID.
A list of rulesets for this organization.
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.
List of users and organizations this entity is sponsoring.
List of sponsors for this user or organization.
Events involving this sponsorable, such as new sponsorships.
The GitHub Sponsors listing for this user or organization.
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.
The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
List of sponsorship updates sent from this sponsorable to sponsors.
The sponsorships where this user or organization is the maintainer receiving the funds.
The sponsorships where this user or organization is the funder.
Find an organization's team by its slug.
A list of teams in this organization.
The HTTP path listing organization's teams
The HTTP URL listing organization's teams
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.
The organization's Twitter username.
Identifies the date and time when the object was last updated.
The HTTP URL for this organization.
Organization is adminable by the viewer.
Can the viewer pin repositories and gists to the profile?
Can the current viewer create new projects on this owner.
Viewer can create repositories on this organization
Viewer can create teams on this organization.
Whether or not the viewer is able to sponsor this user/organization.
Viewer is an active member of this organization.
Whether or not this Organization is followed by the viewer.
True if the viewer is sponsoring this user/organization.
Whether contributors are required to sign off on web-based commits for repositories in this organization.
The organization's public profile URL.
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.
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.
The full description of the listing.
The full description of the listing rendered to HTML.
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.
The Node ID of the SponsorsListing object
Boolean [scalar]
The Boolean
scalar type represents true
or false
.
Whether this listing is publicly visible.
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.
The listing's full name.
A future date on which this listing is eligible to receive a payout.
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.
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.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP path for this Sponsors listing.
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.
The short description of the listing.
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.
The short name of the listing.
Sponsorable [interface]
Entities that can sponsor or be sponsored through GitHub Sponsors.
Attributes
The estimated next GitHub Sponsors payout for this user/organization in cents (USD).
True if this user/organization has a GitHub Sponsors listing.
Whether the given account is sponsoring this user/organization.
True if the viewer is sponsored by this user/organization.
Calculate how much each sponsor has ever paid total to this maintainer via
GitHub Sponsors. Does not include sponsorships paid via Patreon.
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
List of users and organizations this entity is sponsoring.
List of sponsors for this user or organization.
Events involving this sponsorable, such as new sponsorships.
The GitHub Sponsors listing for this user or organization.
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.
The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
List of sponsorship updates sent from this sponsorable to sponsors.
The sponsorships where this user or organization is the maintainer receiving the funds.
The sponsorships where this user or organization is the funder.
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.
Whether or not the viewer is able to sponsor this user/organization.
True if the viewer is sponsoring this user/organization.
The entity this listing represents who can be sponsored on GitHub Sponsors.
SponsorsTierConnection [object]
The connection type for SponsorsTier.
Attributes
A list of edges.
A list of nodes.
Information to aid in pagination.
Identifies the total count of items in the connection.
The tiers for this GitHub Sponsors profile.
URI [scalar]
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
The HTTP URL for this Sponsors listing.