GitHub Apps

Reference documentation for GraphQL schema types in the GitHub Apps category.

In this article

Queries

marketplaceCategories

Query

Get alphabetically sorted list of Marketplace categories.

Type: [MarketplaceCategory!]!

Arguments for marketplaceCategories

NameDescription

excludeEmpty (Boolean)

Exclude categories with no listings.

excludeSubcategories (Boolean)

Returns top level categories only, excluding any subcategories.

includeCategories ([String!])

Return only the specified categories.

marketplaceCategory

Query

Look up a Marketplace category by its slug.

Type: MarketplaceCategory

Arguments for marketplaceCategory

NameDescription

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

marketplaceListing

Query

Look up a single Marketplace listing.

Type: MarketplaceListing

Arguments for marketplaceListing

NameDescription

slug (String!)

Select the listing that matches this slug. It's the short name of the listing used in its URL.

marketplaceListings

Query

Look up Marketplace listings.

Type: MarketplaceListingConnection!

Arguments for marketplaceListings

NameDescription

adminId (ID)

Select listings that can be administered by the specified user.

after (String)

Returns the elements in the list that come after the specified cursor.

allStates (Boolean)

Select listings visible to the viewer even if they are not approved. If omitted or false, only approved listings will be returned.

before (String)

Returns the elements in the list that come before the specified cursor.

categorySlug (String)

Select only listings with the given category.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

organizationId (ID)

Select listings for products owned by the specified organization.

primaryCategoryOnly (Boolean)

Select only listings where the primary category matches the given category slug.

The default value is false.

slugs ([String])

Select the listings with these slugs, if they are visible to the viewer.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

viewerCanAdmin (Boolean)

Select listings to which user has admin access. If omitted, listings visible to the viewer are returned.

withFreeTrialsOnly (Boolean)

Select only listings that offer a free trial.

The default value is false.

Objects

App

Object

A GitHub App.

App Implements

Fields for App

NameDescription

clientId (String)

The client ID of the app.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the app.

id (ID!)

The Node ID of the App object.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

Arguments for ipAllowListEntries

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

logoBackgroundColor (String!)

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

logoUrl (URI!)

A URL pointing to the app's logo.

Arguments for logoUrl

  • size (Int)

    The size of the resulting image.

name (String!)

The name of the app.

slug (String!)

A slug based on the name of the app for use in URLs.

updatedAt (DateTime!)

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

url (URI!)

The URL to the app's homepage.

Bot

Object

A special type of user which takes actions on behalf of GitHub Apps.

Bot Implements

Fields for Bot

NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

Arguments for avatarUrl

  • size (Int)

    The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Bot object.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this bot.

updatedAt (DateTime!)

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

url (URI!)

The HTTP URL for this bot.

MarketplaceCategory

Object

A public description of a Marketplace category.

MarketplaceCategory Implements

Fields for MarketplaceCategory

NameDescription

description (String)

The category's description.

howItWorks (String)

The technical description of how apps listed in this category work with GitHub.

id (ID!)

The Node ID of the MarketplaceCategory object.

name (String!)

The category's name.

primaryListingCount (Int!)

How many Marketplace listings have this as their primary category.

resourcePath (URI!)

The HTTP path for this Marketplace category.

secondaryListingCount (Int!)

How many Marketplace listings have this as their secondary category.

slug (String!)

The short name of the category used in its URL.

url (URI!)

The HTTP URL for this Marketplace category.

MarketplaceListing

Object

A listing in the GitHub integration marketplace.

MarketplaceListing Implements

Fields for MarketplaceListing

NameDescription

app (App)

The GitHub App this listing represents.

companyUrl (URI)