MarketplaceListing

Object

app

The GitHub App this listing represents.

companyUrl

URL to the listing owner's company site.

configurationResourcePath

The HTTP path for configuring access to the listing's integration or OAuth app

configurationUrl

The HTTP URL for configuring access to the listing's integration or OAuth app

documentationUrl

URL to the listing's documentation.

extendedDescription

The listing's detailed description.

extendedDescriptionHTML

The listing's detailed description rendered to HTML.

fullDescription

The listing's introductory description.

fullDescriptionHTML

The listing's introductory description rendered to HTML.

hasPublishedFreeTrialPlans

Does this listing have any plans with a free trial?

hasTermsOfService

Does this listing have a terms of service link?

hasVerifiedOwner

Whether the creator of the app is a verified org

howItWorks

A technical description of how this app works with GitHub.

howItWorksHTML

The listing's technical description rendered to HTML.

id

The Node ID of the MarketplaceListing object

installationUrl

URL to install the product to the viewer's account or organization.

installedForViewer

Whether this listing's app has been installed for the current viewer

isArchived

Whether this listing has been removed from the Marketplace.

isDraft

Whether this listing is still an editable draft that has not been submitted for review and is not publicly visible in the Marketplace.

isPaid

Whether the product this listing represents is available as part of a paid plan.

isPublic

Whether this listing has been approved for display in the Marketplace.

isRejected

Whether this listing has been rejected by GitHub for display in the Marketplace.

isUnverified

Whether this listing has been approved for unverified display in the Marketplace.

isUnverifiedPending

Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

isVerificationPendingFromDraft

Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerificationPendingFromUnverified

Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerified

Whether this listing has been approved for verified display in the Marketplace.

logoBackgroundColor

The hex color code, without the leading '#', for the logo background.

logoUrl

URL for the listing's logo image.

name

The listing's full name.

normalizedShortDescription

The listing's very short description without a trailing period or ampersands.

pricingUrl

URL to the listing's detailed pricing.

primaryCategory

The category that best describes the listing.

privacyPolicyUrl

URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

resourcePath

The HTTP path for the Marketplace listing.

screenshotUrls

The URLs for the listing's screenshots.

secondaryCategory

An alternate category that describes the listing.

shortDescription

The listing's very short description.

slug

The short name of the listing used in its URL.

statusUrl

URL to the listing's status page.

supportEmail

An email address for support for this listing's app.

supportUrl

Either a URL or an email address for support for this listing's app, may return an empty string for listings that do not require a support URL.

termsOfServiceUrl

URL to the listing's terms of service.

url

The HTTP URL for the Marketplace listing.

viewerCanAddPlans

Can the current viewer add plans for this Marketplace listing.

viewerCanApprove

Can the current viewer approve this Marketplace listing.

viewerCanDelist

Can the current viewer delist this Marketplace listing.

viewerCanEdit

Can the current viewer edit this Marketplace listing.

viewerCanEditCategories

Can the current viewer edit the primary and secondary category of this Marketplace listing.

viewerCanEditPlans

Can the current viewer edit the plans for this Marketplace listing.

viewerCanRedraft

Can the current viewer return this Marketplace listing to draft state so it becomes editable again.

viewerCanReject

Can the current viewer reject this Marketplace listing by returning it to an editable draft state or rejecting it entirely.

viewerCanRequestApproval

Can the current viewer request this listing be reviewed for display in the Marketplace as verified.

viewerHasPurchased

Indicates whether the current user has an active subscription to this Marketplace listing.

viewerHasPurchasedForAllOrganizations

Indicates if the current user has purchased a subscription to this Marketplace listing for all of the organizations the user owns.

viewerIsListingAdmin

Does the current viewer role allow them to administer this Marketplace listing.