GitHub GraphQL API

https://docs.github.com/en/graphql
Admin
GitHub GraphQL API enables developers to create integrations, retrieve data, and automate workflows...
Tokens:536,651
Snippets:4,561
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### StartOrganizationMigrationInput

Source: https://docs.github.com/en/graphql/reference/migrations

Input object for the startOrganizationMigration mutation. It defines the fields required to start an organization migration.

```APIDOC
## StartOrganizationMigrationInput - input object

Autogenerated input type of StartOrganizationMigration.

### Input fields for `StartOrganizationMigrationInput`

- `clientMutationId` (String) - Optional - A unique identifier for the client performing the mutation.
- `sourceAccessToken` (String!) - Required - The migration source access token.
- `sourceOrgUrl` (URI!) - Required - The URL of the organization to migrate.
- `targetEnterpriseId` (ID!) - Required - The ID of the enterprise the target organization belongs to.
- `targetOrgName` (String!) - Required - The name of the target organization.
```

--------------------------------

### startOrganizationMigration

Source: https://docs.github.com/en/graphql/reference/migrations

Mutation that starts a GitHub Enterprise Importer organization migration. It takes a StartOrganizationMigrationInput and returns the new organization migration.

```APIDOC
## startOrganizationMigration - mutation

Starts a GitHub Enterprise Importer organization migration.

### Input fields for `startOrganizationMigration`

- `input` (StartOrganizationMigrationInput!) - Required - The input object for the mutation.

### Return fields for `startOrganizationMigration`

- `clientMutationId` (String) - A unique identifier for the client performing the mutation.
- `orgMigration` (OrganizationMigration) - The new organization migration.
```

--------------------------------

### startRepositoryMigration

Source: https://docs.github.com/en/graphql/reference/migrations

Mutation that starts a GitHub Enterprise Importer (GEI) repository migration. It takes a StartRepositoryMigrationInput and returns the new repository migration.

```APIDOC
## startRepositoryMigration - mutation

Starts a GitHub Enterprise Importer (GEI) repository migration.

### Input fields for `startRepositoryMigration`

- `input` (StartRepositoryMigrationInput!) - Required - The input object for the mutation.

### Return fields for `startRepositoryMigration`

- `clientMutationId` (String) - A unique identifier for the client performing the mutation.
- `repositoryMigration` (RepositoryMigration) - The new repository migration.
```

--------------------------------

### GET request for introspection

Source: https://docs.github.com/en/graphql/guides/introduction-to-graphql

Run an introspection query via a GET request. If you get 'Bad credentials' or 401, check your token; a 403 with 'Resource not accessible by personal access token' means your fine-grained token must target the correct resource owner.

```shell
curl -H "Authorization: bearer TOKEN" https://api.github.com/graphql
```

--------------------------------

### User.packages

Source: https://docs.github.com/en/graphql/reference/users

Returns a list of packages under the owner.

```APIDOC
## User.packages

### Description
Returns a list of packages under the owner.

### Type
Field

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **names** ([String]) - Optional - Find packages by their names.
- **orderBy** (PackageOrder) - Optional - Ordering of the returned packages.
- **packageType** (PackageType) - Optional - Filter registry package by type.
- **repositoryId** (ID) - Optional - Find packages in a repository by ID.

### Return Type
PackageConnection!
```

--------------------------------

### GET request with IDL media type

Source: https://docs.github.com/en/graphql/guides/introduction-to-graphql

Pass the 'idl' media type to return the schema in IDL format, a condensed version. This is likely the only GET request you'll run; other requests use POST.

```shell
$ curl -H "Authorization: bearer TOKEN" -H "Accept: application/vnd.github.v4.idl" \
https://api.github.com/graphql
```

--------------------------------

### Repository.discussion

Source: https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions

Get a discussion by its number. Returns null if the discussion does not exist.

```APIDOC
## Repository.discussion

### Description
Get a discussion. Returns `null` if discussion with the specified ID does not exist.

### Signature
```graphql
discussion(number: Int!) : Discussion
```

### Parameters
- **number** (Int!) - Required - The number of the discussion to retrieve.
```

--------------------------------

### EnterpriseServerInstallationOrderField

Source: https://docs.github.com/en/graphql/reference/enterprise-admin

Enumeration of fields by which Enterprise Server installation connections can be ordered.

```APIDOC
## EnterpriseServerInstallationOrderField

### Description
Properties by which Enterprise Server installation connections can be ordered.

### Type
Enum

### Values
- **CREATED_AT** - Order Enterprise Server installations by creation time.
- **CUSTOMER_NAME** - Order Enterprise Server installations by customer name.
- **HOST_NAME** - Order Enterprise Server installations by host name.
```

--------------------------------

### StartRepositoryMigrationInput

Source: https://docs.github.com/en/graphql/reference/migrations

This snippet documents the input object for the StartRepositoryMigration mutation, including all its input fields and their types.

```APIDOC
## StartRepositoryMigrationInput

### Description
Autogenerated input type of StartRepositoryMigration. This input object is used to provide the necessary parameters for the StartRepositoryMigration mutation.

### Input Fields
- **accessToken** (String) - The migration source access token.
- **clientMutationId** (String) - A unique identifier for the client performing the mutation.
- **continueOnError** (Boolean) - Whether to continue the migration on error. Defaults to true.
- **gitArchiveUrl** (String) - The signed URL to access the user-uploaded git archive.
- **githubPat** (String) - The GitHub personal access token of the user importing to the target repository.
- **lockSource** (Boolean) - Whether to lock the source repository.
- **metadataArchiveUrl** (String) - The signed URL to access the user-uploaded metadata archive.
- **ownerId** (ID!) - The ID of the organization that will own the imported repository.
- **repositoryName** (String!) - The name of the imported repository.
- **skipReleases** (Boolean) - Whether to skip migrating releases for the repository.
- **sourceId** (ID!) - The ID of the migration source.
- **sourceRepositoryUrl** (URI!) - The URL of the source repository.
- **targetRepoVisibility** (String) - The visibility of the imported repository.
```

--------------------------------

### EnterpriseServerInstallationOrder

Source: https://docs.github.com/en/graphql/reference/enterprise-admin

Defines the input object for ordering Enterprise Server installation connections.

```APIDOC
## EnterpriseServerInstallationOrder

### Description
Ordering options for Enterprise Server installation connections.

### Type
Input object

### Input fields
- **direction** (`OrderDirection!`) - The ordering direction.
- **field** (`EnterpriseServerInstallationOrderField!`) - The field to order Enterprise Server installations by.
```

--------------------------------

### licenses - query

Source: https://docs.github.com/en/graphql/reference/licenses

Return a list of known open source licenses. This query returns a list of License objects.

```APIDOC
## licenses - query

### Description
Return a list of known open source licenses.

### Type
[License]!

### Response
#### Success Response
A list of License objects, each with the following fields:
- **body** (String!) - The full text of the license.
- **conditions** ([LicenseRule]!) - The conditions set by the license.
- **description** (String) - A human-readable description of the license.
- **featured** (Boolean!) - Whether the license should be featured.
- **hidden** (Boolean!) - Whether the license should be displayed in license pickers.
- **id** (ID!) - The Node ID of the License object.
- **implementation** (String) - Instructions on how to implement the license.
- **key** (String!) - The lowercased SPDX ID of the license.
- **limitations** ([LicenseRule]!) - The limitations set by the license.
- **name** (String!) - The license full name specified by https://spdx.org/licenses.
- **nickname** (String) - Customary short name if applicable (e.g, GPLv3).
- **permissions** ([LicenseRule]!) - The permissions set by the license.
- **pseudoLicense** (Boolean!) - Whether the license is a pseudo-license placeholder (e.g., other, no-license).
- **spdxId** (String) - Short identifier specified by https://spdx.org/licenses.
- **url** (URI) - URL to the license on https://choosealicense.com.
```

--------------------------------

### updateIpAllowListForInstalledAppsEnabledSetting

Source: https://docs.github.com/en/graphql/reference/enterprise-admin

Mutation to update the IP allow list configuration for installed GitHub Apps on an owner.

```APIDOC
## updateIpAllowListForInstalledAppsEnabledSetting - mutation

### Description
Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.

### Input fields for `updateIpAllowListForInstalledAppsEnabledSetting`

- `input` (UpdateIpAllowListForInstalledAppsEnabledSettingInput!): 

### Return fields for `updateIpAllowListForInstalledAppsEnabledSetting`

- `clientMutationId` (String): A unique identifier for the client performing the mutation.
- `owner` (IpAllowListOwner): The IP allow list owner on which the setting was updated.

```

--------------------------------

### Sponsorable - interface

Source: https://docs.github.com/en/graphql/reference/sponsors

Documentation for the Sponsorable interface, including all its fields and their arguments.

```APIDOC
## Sponsorable - interface

### Description
Entities that can sponsor or be sponsored through GitHub Sponsors.

### Fields

#### estimatedNextSponsorsPayoutInCents
- **Type**: Int!
- **Description**: The estimated next GitHub Sponsors payout for this user/organization in cents (USD).

#### hasSponsorsListing
- **Type**: Boolean!
- **Description**: True if this user/organization has a GitHub Sponsors listing.

#### isSponsoredBy
- **Type**: Boolean!
- **Description**: Whether the given account is sponsoring this user/organization.
- **Arguments**:
  - `accountLogin` (String!) - Required - The target account's login.

#### isSponsoringViewer
- **Type**: Boolean!
- **Description**: True if the viewer is sponsored by this user/organization.

#### lifetimeReceivedSponsorshipValues
- **Type**: SponsorAndLifetimeValueConnection!
- **Description**: Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon.
- **Arguments**:
  - `after` (String) - Optional - Returns the elements in the list that come after the specified cursor.
  - `before` (String) - Optional - Returns the elements in the list that come before the specified cursor.
  - `first` (Int) - Optional - Returns the first n elements from the list.
  - `last` (Int) - Optional - Returns the last n elements from the list.
  - `orderBy` (SponsorAndLifetimeValueOrder) - Optional - Ordering options for results returned from the connection.

#### monthlyEstimatedSponsorsIncomeInCents
- **Type**: Int!
- **Description**: The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).

#### sponsoring
- **Type**: SponsorConnection!
- **Description**: List of users and organizations this entity is sponsoring.
- **Arguments**:
  - `after` (String) - Optional - Returns the elements in the list that come after the specified cursor.
  - `before` (String) - Optional - Returns the elements in the list that come before the specified cursor.
  - `first` (Int) - Optional - Returns the first n elements from the list.
  - `last` (Int) - Optional - Returns the last n elements from the list.
  - `orderBy` (SponsorOrder) - Optional - Ordering options for the users and organizations returned from the connection.

#### sponsors
- **Type**: SponsorConnection!
- **Description**: List of sponsors for this user or organization.
- **Arguments**:
  - `after` (String) - Optional - Returns the elements in the list that come after the specified cursor.
  - `before` (String) - Optional - Returns the elements in the list that come before the specified cursor.
  - `first` (Int) - Optional - Returns the first n elements from the list.
  - `last` (Int) - Optional - Returns the last n elements from the list.
  - `orderBy` (SponsorOrder) - Optional - Ordering options for sponsors returned from the connection.
  - `tierId` (ID) - Optional - If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.

#### sponsorsActivities
- **Type**: SponsorsActivityConnection!
- **Description**: Events involving this sponsorable, such as new sponsorships.
- **Arguments**:
  - `actions` ([SponsorsActivityAction!]) - Optional - Filter activities to only the specified actions.
  - `after` (String) - Optional - Returns the elements in the list that come after the specified cursor.
  - `before` (String) - Optional - Returns the elements in the list that come before the specified cursor.
  - `first` (Int) - Optional - Returns the first n elements from the list.
  - `includeAsSponsor` (Boolean) - Optional - Whether to include those events where this sponsorable acted as the sponsor. Defaults to only including events where this sponsorable was the recipient of a sponsorship.
  - `includePrivate` (Boolean) - Optional - Whether or not to include private activities in the result set. Defaults to including public and private activities. Default: `true`.
  - `last` (Int) - Optional - Returns the last n elements from the list.
  - `orderBy` (SponsorsActivityOrder) - Optional - Ordering options for activity returned from the connection.
  - `period` (SponsorsActivityPeriod) - Optional - Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred. Will be ignored if since or until is given. Default: `MONTH`.
  - `since` (DateTime) - Optional - Filter activities to those that occurred on or after this time.
  - `until` (DateTime) - Optional - Filter activities to those that occurred before this time.

#### sponsorsListing
- **Type**: SponsorsListing
- **Description**: The GitHub Sponsors listing for this user or organization.

#### sponsorshipForViewerAsSponsor
- **Type**: Sponsorship
- **Description**: The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.
- **Arguments**:
  - `activeOnly` (Boolean) - Optional - Whether to return the sponsorship only if it's still active. Pass false to get the viewer's sponsorship back even if it has been cancelled. Default: `true`.

#### sponsorshipForViewerAsSponsorable
- **Type**: Sponsorship
- **Description**: The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
- **Arguments**:
  - `activeOnly` (Boolean) - Optional - Whether to return the sponsorship only if it's still active. Pass false to get the sponsorship back even if it has been cancelled. Default: `true`.
```

--------------------------------

### EnterpriseServerUserAccount

Source: https://docs.github.com/en/graphql/reference/enterprise-admin

Represents a user account on an Enterprise Server installation, including its fields and connection arguments.

```APIDOC
## EnterpriseServerUserAccount

### Description
A user account on an Enterprise Server installation.

### Type
Object

### Implements
- Node

### Fields
- **createdAt** (`DateTime!`) - Identifies the date and time when the object was created.
- **emails** (`EnterpriseServerUserAccountEmailConnection!`) - User emails belonging to this user account.
  - **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.
  - **orderBy** (`EnterpriseServerUserAccountEmailOrder`) - Ordering options for Enterprise Server user account emails returned from the connection.
- **enterpriseServerInstallation** (`EnterpriseServerInstallation!`) - The Enterprise Server installation on which this user account exists.
- **id** (`ID!`) - The Node ID of the EnterpriseServerUserAccount object.
- **isSiteAdmin** (`Boolean!`) - Whether the user account is a site administrator on the Enterprise Server installation.
- **login** (`String!`) - The login of the user account on the Enterprise Server installation.
- **profileName** (`String`) - The profile name of the user account on the Enterprise Server installation.
- **remoteCreatedAt** (`DateTime!`) - The date and time when the user account was created on the Enterprise Server installation.
- **remoteUserId** (`Int!`) - The ID of the user account on the Enterprise Server installation.
- **updatedAt** (`DateTime!`) - Identifies the date and time when the object was last updated.
```

--------------------------------

### license - query

Source: https://docs.github.com/en/graphql/reference/licenses

Look up an open source license by its key. This query returns a License object.

```APIDOC
## license - query

### Description
Look up an open source license by its key.

### Type
License

### Arguments
- **key** (String!) - Required - The license's downcased SPDX ID.

### Response
#### Success Response
- **body** (String!) - The full text of the license.
- **conditions** ([LicenseRule]!) - The conditions set by the license.
- **description** (String) - A human-readable description of the license.
- **featured** (Boolean!) - Whether the license should be featured.
- **hidden** (Boolean!) - Whether the license should be displayed in license pickers.
- **id** (ID!) - The Node ID of the License object.
- **implementation** (String) - Instructions on how to implement the license.
- **key** (String!) - The lowercased SPDX ID of the license.
- **limitations** ([LicenseRule]!) - The limitations set by the license.
- **name** (String!) - The license full name specified by https://spdx.org/licenses.
- **nickname** (String) - Customary short name if applicable (e.g, GPLv3).
- **permissions** ([LicenseRule]!) - The permissions set by the license.
- **pseudoLicense** (Boolean!) - Whether the license is a pseudo-license placeholder (e.g., other, no-license).
- **spdxId** (String) - Short identifier specified by https://spdx.org/licenses.
- **url** (URI) - URL to the license on https://choosealicense.com.
```

--------------------------------

### User.repositoryDiscussions

Source: https://docs.github.com/en/graphql/reference/users

Retrieves discussions started by the user, with optional filtering by repository, answer status, and state.

```APIDOC
## User.repositoryDiscussions

### Description
Discussions this user has started.

### Type
DiscussionConnection!

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **answered** (Boolean) - Optional - Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (DiscussionOrder) - Optional - Ordering options for discussions returned from the connection.
- **repositoryId** (ID) - Optional - Filter discussions to only those in a specific repository.
- **states** ([DiscussionState!]) - Optional - A list of states to filter the discussions by.

```

--------------------------------

### createRepository

Source: https://docs.github.com/en/graphql/reference/repos

Mutation to create a new repository with specified settings.

```APIDOC
## createRepository - mutation

### Description
Creates a new repository. This mutation is used to create a repository with the specified name, owner, and other optional settings.

### Method
mutation

### Endpoint
createRepository

### Parameters
#### Input Fields (`CreateRepositoryInput`)
- **clientMutationId** (String) - Optional - A unique identifier for the client performing the mutation.
- **description** (String) - Optional - A short description of the new repository.
- **hasIssuesEnabled** (Boolean) - Optional - Indicates if the repository should have the issues feature enabled.
- **hasWikiEnabled** (Boolean) - Optional - Indicates if the repository should have the wiki feature enabled.
- **homepageUrl** (URI) - Optional - The URL for a web page about this repository.
- **name** (String!) - Required - The name of the new repository.
- **ownerId** (ID) - Optional - The ID of the owner for the new repository.
- **teamId** (ID) - Optional - When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository.
- **template** (Boolean) - Optional - Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.
- **visibility** (RepositoryVisibility!) - Required - Indicates the repository's visibility level.

### Request Example
```graphql
mutation {
  createRepository(input: {
    name: "example-repo",
    visibility: PUBLIC,
    description: "A new repository"
  }) {
    clientMutationId
    repository {
      id
      name
    }
  }
}
```

### Response
#### Success Response
- **clientMutationId** (String) - A unique identifier for the client performing the mutation.
- **repository** (Repository) - The newly created repository.

#### Response Example
```json
{
  "data": {
    "createRepository": {
      "clientMutationId": null,
      "repository": {
        "id": "MDEwOlJlcG9zaXRvcnkx",
        "name": "example-repo"
      }
    }
  }
}
```
```

--------------------------------

### User Fields

Source: https://docs.github.com/en/graphql/reference/users

Documentation for the fields of the GraphQL User object, including their types, arguments, and usage examples.

```APIDOC
## Field: `User.resourcePath`

### Description
Returns the HTTP path for this user.

### Type
URI!

### Arguments
None

### Response Example
```graphql
{
  user(login: "octocat") {
    resourcePath
  }
}
```

```

```APIDOC
## Field: `User.savedReplies`

### Description
Returns replies this user has saved.

### Type
SavedReplyConnection

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (SavedReplyOrder) - Optional - The field to order saved replies by.

### Response Example
```graphql
{
  user(login: "octocat") {
    savedReplies(first: 10) {
      nodes {
        id
      }
    }
  }
}
```

```

```APIDOC
## Field: `User.socialAccounts`

### Description
Returns the user's social media accounts, ordered as they appear on the user's profile.

### Type
SocialAccountConnection!

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.

### Response Example
```graphql
{
  user(login: "octocat") {
    socialAccounts(first: 10) {
      nodes {
        provider
      }
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsoring`

### Description
Returns a list of users and organizations this entity is sponsoring.

### Type
SponsorConnection!

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (SponsorOrder) - Optional - Ordering options for the users and organizations returned from the connection.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsoring(first: 10) {
      nodes {
        login
      }
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsors`

### Description
Returns a list of sponsors for this user or organization.

### Type
SponsorConnection!

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (SponsorOrder) - Optional - Ordering options for sponsors returned from the connection.
- **tierId** (ID) - Optional - If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsors(first: 10) {
      nodes {
        login
      }
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsorsActivities`

### Description
Returns events involving this sponsorable, such as new sponsorships.

### Type
SponsorsActivityConnection!

### Arguments
- **actions** ([SponsorsActivityAction!]) - Optional - Filter activities to only the specified actions.
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **includeAsSponsor** (Boolean) - Optional - Whether to include those events where this sponsorable acted as the sponsor. Defaults to only including events where this sponsorable was the recipient of a sponsorship.
- **includePrivate** (Boolean) - Optional - Whether or not to include private activities in the result set. Defaults to including public and private activities. Default: `true`.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (SponsorsActivityOrder) - Optional - Ordering options for activity returned from the connection.
- **period** (SponsorsActivityPeriod) - Optional - Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred. Will be ignored if since or until is given. Default: `MONTH`.
- **since** (DateTime) - Optional - Filter activities to those that occurred on or after this time.
- **until** (DateTime) - Optional - Filter activities to those that occurred before this time.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsorsActivities(first: 10) {
      nodes {
        id
      }
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsorsListing`

### Description
Returns the GitHub Sponsors listing for this user or organization.

### Type
SponsorsListing

### Arguments
None

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsorsListing {
      id
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsorshipForViewerAsSponsor`

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

### Type
Sponsorship

### Arguments
- **activeOnly** (Boolean) - Optional - Whether to return the sponsorship only if it's still active. Pass false to get the viewer's sponsorship back even if it has been cancelled. Default: `true`.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsorshipForViewerAsSponsor {
      id
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsorshipForViewerAsSponsorable`

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

### Type
Sponsorship

### Arguments
- **activeOnly** (Boolean) - Optional - Whether to return the sponsorship only if it's still active. Pass false to get the sponsorship back even if it has been cancelled. Default: `true`.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsorshipForViewerAsSponsorable {
      id
    }
  }
}
```

```

```APIDOC
## Field: `User.sponsorshipNewsletters`

### Description
Returns a list of sponsorship updates sent from this sponsorable to sponsors.

### Type
SponsorshipNewsletterConnection!

### Arguments
- **after** (String) - Optional - Returns the elements in the list that come after the specified cursor.
- **before** (String) - Optional - Returns the elements in the list that come before the specified cursor.
- **first** (Int) - Optional - Returns the first n elements from the list.
- **last** (Int) - Optional - Returns the last n elements from the list.
- **orderBy** (SponsorshipNewsletterOrder) - Optional - Ordering options for sponsorship updates returned from the connection.

### Response Example
```graphql
{
  user(login: "octocat") {
    sponsorshipNewsletters(first: 10) {
      nodes {
        id
      }
    }
  }
}
```

```

--------------------------------

### Deployment and Environment Mutations

Source: https://docs.github.com/en/graphql/reference/deployments

GraphQL mutations and input objects for managing deployments and environments.

```APIDOC
## Mutation: deleteDeployment

### Description
Deletes a deployment.

### Input Fields
- `input` (DeleteDeploymentInput!) - Required - The input object for the mutation.

### Return Fields
- `clientMutationId` (String) - A unique identifier for the client performing the mutation.

## Input Object: DeleteDeploymentInput

### Description
Autogenerated input type of DeleteDeployment.

### Input Fields
- `clientMutationId` (String) - A unique identifier for the client performing the mutation.
- `id` (ID!) - Required - The Node ID of the deployment to be deleted.

## Mutation: deleteEnvironment

### Description
Deletes an environment.

### Input Fields
- `input` (DeleteEnvironmentInput!) - Required - The input object for the mutation.

### Return Fields
- `clientMutationId` (String) - A unique identifier for the client performing the mutation.

## Input Object: DeleteEnvironmentInput

### Description
Autogenerated input type of DeleteEnvironment.

### Input Fields
- `clientMutationId` (String) - A unique identifier for the client performing the mutation.
- `id` (ID!) - Required - The Node ID of the environment to be deleted.

## Input Object: CreateEnvironmentInput

### Description
Autogenerated input type of CreateEnvironment.

### Input Fields
- `clientMutationId` (String) - A unique identifier for the client performing the mutation.
- `name` (String!) - Required - The name of the environment.
- `repositoryId` (ID!) - Required - The node ID of the repository.
```

--------------------------------

### RepositoryDiscussionAuthor

Source: https://docs.github.com/en/graphql/reference/discussions

Interface representing an author of discussions in repositories. Provides a connection to discussions the user has started with filtering and ordering options.

```APIDOC
## RepositoryDiscussionAuthor - interface

Represents an author of discussions in repositories.

### Fields for `RepositoryDiscussionAuthor`

* `repositoryDiscussions` (DiscussionConnection!): Discussions this user has started.
  * `after` (String): Returns the elements in the list that come after the specified cursor.
  * `answered` (Boolean): Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.
  * `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.
  * `orderBy` (DiscussionOrder): Ordering options for discussions returned from the connection.
  * `repositoryId` (ID): Filter discussions to only those in a specific repository.
  * `states` ([DiscussionState!]): A list of states to filter the discussions by.

### Implemented by

* Organization
* User
```

--------------------------------

### CreateDeploymentInput - input object

Source: https://docs.github.com/en/graphql/reference/deployments

Input object for the createDeployment mutation. Contains required fields refId and repositoryId, and optional fields for autoMerge, description, environment, payload, requiredContexts, task, and clientMutationId.

```APIDOC
## CreateDeploymentInput - input object

### Description
Autogenerated input type of CreateDeployment.

### Input Fields
- **autoMerge** (Boolean) - Optional - Attempt to automatically merge the default branch into the requested ref, defaults to true.
- **clientMutationId** (String) - Optional - A unique identifier for the client performing the mutation.
- **description** (String) - Optional - Short description of the deployment.
- **environment** (String) - Optional - Name for the target deployment environment.
- **payload** (String) - Optional - JSON payload with extra information about the deployment.
- **refId** (ID!) - Required - The node ID of the ref to be deployed.
- **repositoryId** (ID!) - Required - The node ID of the repository.
- **requiredContexts** ([String!]) - Optional - The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts.
- **task** (String) - Optional - Specifies a task to execute.

```

--------------------------------

### createProjectV2View

Source: https://docs.github.com/en/graphql/reference/projects

GraphQL mutation to create a new view in a project. It requires an input object with the project ID, view name, layout, and optional configuration.

```APIDOC
## createProjectV2View - mutation

### Description
Creates a new view in a project.

### Input Fields
- **input** (CreateProjectV2ViewInput!) - Required - The input for the mutation.

### Return Fields
- **clientMutationId** (String) - A unique identifier for the client performing the mutation.
- **projectV2View** (ProjectV2View) - The new view.

### Input Object: CreateProjectV2ViewInput
- **clientMutationId** (String) - Optional - A unique identifier for the client performing the mutation.
- **configuration** (ProjectV2ViewConfigurationInput) - Optional - The configuration for the view.
- **layout** (ProjectV2ViewLayout!) - Required - The layout of the view.
- **name** (String!) - Required - The name of the view.
- **projectId** (ID!) - Required - The ID of the project to create a view in.
```
Tokens:
Raw