GitHub API Integration Vol.1

Suggest Edits

These are the list of integration use cases supported by Knit for GitHub API as part of the TICKETING category

Delete a Discussion (Legacy)

ID: delete_a_discussion_legacy
Operation: write
Entities: discussion, team
Summary: The 'Delete a Discussion (Legacy)' API endpoint allows users to delete a discussion from a team's page using the DELETE method. This endpoint requires OAuth app tokens or personal access tokens with the write:discussion scope. The request must include the 'Authorization' header with a bearer token. The 'accept' header should be set to 'application/vnd.github+json'. The path parameters 'team_id' and 'discussion_number' are required to specify the team and discussion to be deleted. The endpoint returns a 204 No Content status code upon successful deletion. Note that this endpoint is being deprecated, and users are advised to migrate to the new Delete a discussion endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a label

ID: delete_a_label
Operation: write
Entities: token, repository, label
Summary: The 'Delete a label' API endpoint allows users to delete a label from a specified GitHub repository. It requires DELETE method and the endpoint URL is 'https://api.github.com/repos/{owner}/{repo}/labels/{name}'. The request must include path parameters: 'owner' (the account owner of the repository), 'repo' (the name of the repository), and 'name' (the name of the label to delete). The request headers should include 'accept' (recommended to set to 'application/vnd.github+json'), 'Authorization' (Bearer token for authentication), and optionally 'X-GitHub-Api-Version'. The API returns a 204 No Content status code upon successful deletion. The endpoint requires fine-grained access tokens with specific permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a milestone

ID: delete_a_milestone
Operation: write
Entities: milestone, repository, token
Summary: The 'Delete a milestone' API endpoint allows users to delete a specific milestone from a GitHub repository using the milestone number. It requires authentication via a Bearer token and supports fine-grained access tokens with specific permissions. The request must include the repository owner, repository name, and milestone number as path parameters. The 'accept' header is recommended to be set to 'application/vnd.github+json'. A successful deletion returns a 204 No Content status, while a 404 status indicates that the resource was not found.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Repository

ID: delete_a_repository
Operation: write
Entities: repository, token, organization
Summary: The 'Delete a Repository' API allows users with admin access to delete a specified repository. The request requires the 'delete_repo' scope for OAuth app tokens and personal access tokens. The endpoint requires the 'Administration' repository permissions set to 'write' for fine-grained tokens. The API takes path parameters 'owner' and 'repo' to specify the repository to delete. It returns a 204 No Content status code on successful deletion. If the organization prevents members from deleting repositories, a 403 Forbidden response is returned. A 404 status code is returned if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Team

ID: delete_a_team
Operation: write
Entities: team, user, organization
Summary: The 'Delete a Team' API allows an authenticated user, who must be an organization owner or team maintainer, to delete a team within an organization. If the user is an organization owner and deletes a parent team, all child teams will also be deleted. The API requires the organization name and team slug as path parameters. The request must include an Authorization header with a bearer token. The API responds with a 204 No Content status code upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a team (Legacy)

ID: delete_a_team_legacy
Operation: write
Entities: organization owner, team, team maintainer
Summary: The 'Delete a team (Legacy)' API endpoint allows an authenticated user, who must be an organization owner or team maintainer, to delete a team identified by its unique team_id. If the user is an organization owner and deletes a parent team, all of its child teams will also be deleted. The request requires an Authorization header with a bearer token. The endpoint is being deprecated, and users are advised to migrate to the new Delete a team endpoint. The response status code 204 indicates successful deletion with no content returned, while 404 indicates the resource was not found, and 422 indicates validation failure or potential spamming of the endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an organization

ID: delete_an_organization
Operation: write
Entities: repository, token, organization
Summary: The 'Delete an organization' API endpoint allows you to delete an organization and all its repositories on GitHub. The organization login will be unavailable for 90 days after deletion. It requires a fine-grained access token with 'Administration' organization permissions (write). The request must include the organization name as a path parameter and an authorization bearer token in the headers. The 'accept' header should be set to 'application/vnd.github+json'. Upon successful deletion, the API returns a 202 Accepted status code with an empty response body. Other possible status codes include 403 Forbidden and 404 Resource not found.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an autolink reference from a repository

ID: delete_autolink_reference_from_repository
Operation: write
Entities: autolink, owner, repository
Summary: This API endpoint deletes a single autolink reference by ID that was configured for a given repository. It requires the user to have 'Administration' repository permissions with write access. The request must include the repository owner, repository name, and the unique autolink ID as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. A successful deletion returns a 204 No Content status, while a 404 status indicates that the resource was not found.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel an Organization Invitation

ID: delete_cancel_organization_invitation
Operation: write
Entities: organization, user, invitation
Summary: The 'Cancel an Organization Invitation' API allows an authenticated user, who must be an organization owner, to cancel an invitation to join the organization. The endpoint requires the organization name and the invitation ID as path parameters. The request must include an authorization header with a bearer token that has 'Members' organization permissions (write). The API responds with a 204 status code if successful, indicating that the invitation was canceled. If the resource is not found, a 404 status code is returned, and a 422 status code is returned if validation fails or the endpoint has been spammed.
Input Fields: Input Fields
Output Fields: Output Fields

Decline a Repository Invitation

ID: delete_decline_repository_invitation
Operation: write
Entities: repository invitation, token, user
Summary: The 'Decline a Repository Invitation' API allows a user to decline an invitation to a repository. The request requires a DELETE method to the endpoint '/user/repository_invitations/{invitation_id}', where 'invitation_id' is a required path parameter representing the unique identifier of the invitation. The request headers should include an 'Authorization' header with a bearer token, and it is recommended to set the 'accept' header to 'application/vnd.github+json'. The API responds with a 204 No Content status code if the invitation is successfully declined. Other possible response codes include 304 Not Modified, 403 Forbidden, and 404 Resource Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

Disable Automated Security Fixes

ID: delete_disable_automated_security_fixes
Operation: write
Entities: security fix, repository, token
Summary: The 'Disable Automated Security Fixes' API disables automated security fixes for a specified repository. The authenticated user must have admin access to the repository. The API requires a DELETE request to the endpoint with the repository owner and name as path parameters. The request headers should include an 'Authorization' bearer token with 'Administration' repository permissions (write). The 'accept' header is recommended to be set to 'application/vnd.github+json'. A successful request returns a 204 No Content status, indicating that the automated security fixes have been disabled.
Input Fields: Input Fields
Output Fields: Output Fields

Disable Vulnerability Alerts

ID: delete_disable_vulnerability_alerts
Operation: write
Entities: vulnerability alert, repository, user
Summary: The 'Disable Vulnerability Alerts' API disables dependency alerts and the dependency graph for a specified repository. The authenticated user must have admin access to the repository. This endpoint requires a fine-grained access token with 'Administration' repository permissions set to write. The request must include the 'Authorization' header with a valid bearer token. The 'accept' header is recommended to be set to 'application/vnd.github+json'. The path parameters 'owner' and 'repo' are required to specify the repository. A successful request returns a 204 No Content status, indicating that the vulnerability alerts have been successfully disabled.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a discussion comment

ID: delete_discussion_comment
Operation: write
Entities: comment, team, organization
Summary: The 'Delete a discussion comment' API endpoint allows users to delete a comment on a team discussion within an organization on GitHub. To use this endpoint, the user must have a valid OAuth app token or personal access token with the 'write:discussion' scope. The request requires the organization name, team slug, discussion number, and comment number as path parameters. The 'accept' header should be set to 'application/vnd.github+json' for compatibility. Upon successful deletion, the API returns a 204 No Content status, indicating that the comment has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Discussion Comment (Legacy)

ID: delete_discussion_comment_legacy
Operation: write
Entities: discussion, comment, team
Summary: The 'Delete a Discussion Comment (Legacy)' API endpoint allows users to delete a comment on a team discussion. This endpoint is part of the legacy Teams API and is scheduled for deprecation. Users are advised to migrate to the new endpoint. To use this endpoint, OAuth app tokens and personal access tokens (classic) must have the write:discussion scope. The request requires the team_id, discussion_number, and comment_number as path parameters. The recommended accept header is application/vnd.github+json. A successful request returns a 204 No Content status, indicating the comment was successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Discussion from a Team's Page

ID: delete_discussion_from_team_page
Operation: write
Entities: discussion, team, organization
Summary: This API endpoint allows you to delete a discussion from a team's page on GitHub. To use this endpoint, you need to provide the organization name, team slug, and the discussion number as path parameters. The request must include an Authorization header with a valid bearer token that has the write:discussion scope. The accept header is recommended to be set to application/vnd.github+json. Upon successful deletion, the API returns a 204 No Content status code, indicating that the discussion has been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Email Address for the Authenticated User

ID: delete_email_address_for_authenticated_user
Operation: write
Entities: email address, token, user
Summary: This API endpoint allows the authenticated user to delete email addresses associated with their GitHub account. It requires OAuth app tokens or personal access tokens with the user scope, or fine-grained access tokens with 'Email addresses' user permissions set to write. The request must include an array of email addresses in the body. The response will return a status code of 204 if successful, indicating no content. Other possible status codes include 304 (Not modified), 401 (Requires authentication), 403 (Forbidden), 404 (Resource not found), and 422 (Validation failed or endpoint spammed).
Input Fields: Input Fields
Output Fields: Output Fields

Delete a file in a repository

ID: delete_file_in_repository
Operation: write
Entities: file, committer, repository
Summary: The 'Delete a file in a repository' API endpoint allows users to delete a file from a specified repository on GitHub. The request requires the repository owner, repository name, and file path as path parameters. The request body must include a commit message and the SHA of the file to be deleted. Optionally, users can specify the branch, committer, and author details. The committer and author objects must include both name and email if provided. The API returns a response with details of the commit made to delete the file. The endpoint requires authentication via a bearer token and supports fine-grained access tokens with specific permissions. It is important to use this endpoint serially with the 'Create or update file contents' endpoint to avoid conflicts.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a GPG key for the authenticated user

ID: delete_gpg_key_for_authenticated_user
Operation: write
Entities: GPG key, token, user
Summary: This API endpoint allows the authenticated user to delete a GPG key from their GitHub account. The request requires a DELETE method to the endpoint /user/gpg_keys/{gpg_key_id} with the gpg_key_id as a path parameter. The request headers should include an 'accept' header set to 'application/vnd.github+json', an 'Authorization' header with a Bearer token, and optionally an 'X-GitHub-Api-Version'. The response will have a status code of 204 if successful, indicating that the GPG key was deleted. Other possible status codes include 304 (Not modified), 401 (Requires authentication), 403 (Forbidden), 404 (Resource not found), and 422 (Validation failed or endpoint spammed).
Input Fields: Input Fields
Output Fields: Output Fields

Delete a hosted compute network configuration from an organization

ID: delete_hosted_compute_network_configuration
Operation: write
Entities: network configuration, organization
Summary: This API endpoint deletes a hosted compute network configuration from a specified organization. It requires OAuth app tokens or personal access tokens with the write:network_configurations scope. The request must include the organization name and the unique identifier of the network configuration as path parameters. The response will return a 204 No Content status code if the deletion is successful. The 'accept' header should be set to 'application/vnd.github+json', and the 'Authorization' header must include a valid bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Issue Comment

ID: delete_issue_comment
Operation: write
Entities: comment, repository, issue
Summary: The 'Delete an Issue Comment' API allows users to delete comments on issues and pull requests in a GitHub repository. This API requires authentication via a fine-grained access token with either 'Issues' or 'Pull requests' repository permissions set to write. The request must include the repository owner's name, the repository name, and the unique identifier of the comment to be deleted. The API responds with a 204 No Content status code upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an organization repository ruleset

ID: delete_organization_repository_ruleset
Operation: write
Entities: ruleset, repository, organization
Summary: This API endpoint deletes a ruleset for a specified organization. It requires the organization name and the ruleset ID as path parameters. The request must include an Authorization header with a bearer token that has 'Administration' organization permissions (write). The 'accept' header should be set to 'application/vnd.github+json'. Upon successful deletion, the API returns a 204 No Content status. If the resource is not found, a 404 status is returned, and a 500 status indicates an internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Remove an organization role from a team

ID: delete_organization_role_from_team
Operation: write
Entities: team, organization role, organization
Summary: The 'Remove an organization role from a team' API endpoint allows an authenticated user, who must be an administrator for the organization, to remove a specific organization role from a team. The endpoint requires the use of OAuth app tokens or personal access tokens with the 'admin:org' scope. It also supports fine-grained access tokens with 'Members' organization permissions set to write. The request must include the organization name, team slug, and role ID as path parameters. The response will return a 204 No Content status code upon successful removal of the role.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Organization Webhook

ID: delete_organization_webhook
Operation: write
Entities: webhook, token, organization
Summary: The 'Delete an Organization Webhook' API allows an authenticated user, who must be an organization owner, to delete a webhook for an organization. The user must provide a valid OAuth app token or personal access token with 'admin:org_hook' scope. The API requires the organization name and the unique identifier of the webhook as path parameters. The response will be a 204 No Content status code if the deletion is successful, or a 404 Resource not found if the webhook does not exist.
Input Fields: Input Fields
Output Fields: Output Fields

Disable private vulnerability reporting for a repository

ID: delete_private_vulnerability_reporting
Operation: write
Entities: vulnerability reporting, repository, user
Summary: This API endpoint disables private vulnerability reporting for a specified repository. The authenticated user must have admin access to the repository. The endpoint requires a DELETE request to the URL with the repository owner and name as path parameters. The request headers should include an authorization token with 'Administration' repository permissions (write) and optionally accept header set to 'application/vnd.github+json'. A successful request returns a 204 status code with no content. If the request is malformed, a 422 status code is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Public Organization Membership for Authenticated User

ID: delete_public_organization_membership
Operation: write
Entities: organization, user, membership
Summary: This API endpoint removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. It requires fine-grained access tokens with 'Members' organization permissions set to write. The request must include the organization name and the GitHub username as path parameters. The response will return a 204 No Content status code if successful.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a public SSH key for the authenticated user

ID: delete_public_ssh_key_for_authenticated_user
Operation: write
Entities: user, token, key
Summary: This API endpoint deletes a public SSH key from the authenticated user's GitHub account. It requires the 'admin:public_key' scope for OAuth app tokens and personal access tokens (classic). Fine-grained access tokens must have 'Git SSH keys' user permissions set to write. The request requires the 'key_id' path parameter, which is the unique identifier of the key to be deleted. The 'accept' header should be set to 'application/vnd.github+json'. The response will have a status code of 204 if successful, indicating that the key was deleted. Other possible status codes include 304 (Not modified), 401 (Requires authentication), 403 (Forbidden), and 404 (Resource not found).
Input Fields: Input Fields
Output Fields: Output Fields

Remove all labels from an issue

ID: delete_remove_all_labels_from_an_issue
Operation: write
Entities: repository, label, issue
Summary: The 'Remove all labels from an issue' API endpoint allows users to remove all labels from a specified issue in a GitHub repository. It requires DELETE method and the endpoint URL includes path parameters: 'owner' (the account owner of the repository), 'repo' (the name of the repository), and 'issue_number' (the number identifying the issue). The request headers should include 'accept' (recommended to be set to application/vnd.github+json), 'Authorization' (Bearer token for authentication), and optionally 'X-GitHub-Api-Version'. The API returns a 204 No Content status code on success, indicating that all labels have been removed from the issue. Other possible response codes include 301 Moved Permanently, 404 Resource Not Found, and 410 Gone.
Input Fields: Input Fields
Output Fields: Output Fields

Remove all organization roles for a team

ID: delete_remove_all_organization_roles_for_a_team
Operation: write
Entities: role, team, organization
Summary: The 'Remove all organization roles for a team' API endpoint allows an authenticated user, who must be an administrator for the organization, to remove all assigned organization roles from a specified team within the organization. The endpoint requires a DELETE request to the URL 'https://api.github.com/orgs/{org}/organization-roles/teams/{team_slug}', where 'org' is the organization name and 'team_slug' is the slug of the team name. The request headers should include an 'Authorization' bearer token with 'admin:org' scope, and it is recommended to set the 'accept' header to 'application/vnd.github+json'. The API responds with a 204 No Content status code upon successful removal of roles. This endpoint supports fine-grained access tokens with 'Members' organization permissions set to write.
Input Fields: Input Fields
Output Fields: Output Fields

Remove all organization roles for a user

ID: delete_remove_all_organization_roles_for_a_user
Operation: write
Entities: role, user, organization
Summary: The 'Remove all organization roles for a user' API endpoint revokes all assigned organization roles from a specified user within an organization. The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the admin:org scope, while fine-grained tokens must have 'Members' organization permissions (write). The request requires the organization name and the GitHub username as path parameters. The response returns a 204 No Content status code upon successful execution.
Input Fields: Input Fields
Output Fields: Output Fields

Remove assignees from an issue

ID: delete_remove_assignees_from_issue
Operation: write
Entities: assignee, repository, issue
Summary: The 'Remove assignees from an issue' API endpoint allows users to remove one or more assignees from a specific issue in a GitHub repository. This DELETE request requires the repository owner's username, the repository name, and the issue number as path parameters. The request headers should include an 'Authorization' token and can optionally include an 'Accept' header set to 'application/vnd.github+json'. The body of the request should contain an array of assignee usernames to be removed. The response includes detailed information about the issue, such as its ID, URL, state, title, body, user details, labels, assignees, milestone, and more. The API requires fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions set to 'write'.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a Custom Property for an Organization

ID: delete_remove_custom_property_for_organization
Operation: write
Entities: custom property, user, organization
Summary: The 'Remove a Custom Property for an Organization' API endpoint allows an authenticated user to delete a custom property defined for an organization. The user must be an administrator or have specific permissions within the organization. The request requires the organization name and the custom property name as path parameters. The response will return a 204 status code with no content if successful. Possible error responses include 403 Forbidden and 404 Resource not found.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a label from an issue

ID: delete_remove_label_from_issue
Operation: write
Entities: repository, label, issue
Summary: The 'Remove a label from an issue' API endpoint allows you to remove a specified label from an issue in a GitHub repository. It requires DELETE method and the endpoint URL includes path parameters such as owner, repo, issue_number, and name of the label. The request headers should include an Authorization token and can optionally include an accept header set to application/vnd.github+json. Upon successful removal, it returns the remaining labels on the issue. If the label does not exist, a 404 Not Found status is returned. The response includes an array of label objects, each containing details like id, node_id, url, name, description, color, and default status.
Input Fields: Input Fields
Output Fields: Output Fields

Remove an Organization Member

ID: delete_remove_organization_member
Operation: write
Entities: team, user, organization
Summary: The 'Remove an Organization Member' API endpoint allows you to remove a user from an organization on GitHub. This action will remove the user from all teams and revoke their access to the organization's repositories. The API requires a DELETE request to the endpoint '/orgs/{org}/members/{username}', where 'org' is the organization name and 'username' is the GitHub user handle. The request must include an Authorization header with a valid bearer token that has 'Members' organization permissions (write). A successful request returns a 204 No Content status, indicating that the user has been removed. If the request is forbidden, a 403 status is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Organization Membership for a User

ID: delete_remove_organization_membership_for_a_user
Operation: write
Entities: organization, user, membership
Summary: This API endpoint allows an authenticated user, who must be an organization owner, to remove a user's membership from an organization. If the user is an active member, they will be removed; if they have been invited, the invitation will be canceled. The user will receive an email notification in both cases. The endpoint requires a DELETE request to the URL with the organization name and username as path parameters. The request must include an Authorization header with a bearer token that has 'Members' organization permissions (write). The response will have a status code of 204 if successful, indicating no content. Other possible status codes include 403 for forbidden access and 404 if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Remove an organization role from a user

ID: delete_remove_organization_role_from_user
Operation: write
Entities: role, user, organization
Summary: This API endpoint removes an organization role from a user. The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the admin:org scope. Fine-grained access tokens must have 'Members' organization permissions (write). The request requires the organization name, the GitHub username, and the role ID as path parameters. The response returns a 204 No Content status code upon successful removal of the role.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Outside Collaborator from an Organization

ID: delete_remove_outside_collaborator
Operation: write
Entities: repository, outside collaborator, organization
Summary: The 'Remove Outside Collaborator from an Organization' API allows you to remove a user from the list of outside collaborators for a GitHub organization. This action will remove the user from all repositories within the organization. The API requires a DELETE request to the endpoint '/orgs/{org}/outside_collaborators/{username}' with the organization name and the GitHub username as path parameters. The request must include an Authorization header with a bearer token that has 'Members' organization permissions (write). The 'accept' header should be set to 'application/vnd.github+json'. A successful request returns a 204 No Content status, while a 422 Unprocessable Entity status is returned if the user is a member of the organization.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a project from a team

ID: delete_remove_project_from_team
Operation: write
Entities: team, project, organization
Summary: The 'Remove a project from a team' API endpoint allows an organization owner or a team maintainer to remove a project from a team. The authenticated user must have read access to both the team and project, or admin access to the team or project to perform this action. The endpoint requires the organization name, team slug, and project ID as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. A successful request returns a 204 No Content status, indicating the project was removed from the team without deleting the project itself.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a project from a team (Legacy)

ID: delete_remove_project_from_team_legacy
Operation: write
Entities: team, project, organization
Summary: The 'Remove a project from a team (Legacy)' API endpoint allows an organization owner or a team maintainer to remove a project from a team. The authenticated user must have the necessary permissions, such as read access to both the team and project, or admin access to either. This endpoint does not delete the project but only removes it from the team. The request requires the team_id and project_id as path parameters and an Authorization header with a bearer token. The response status code 204 indicates success with no content, while 404 indicates the resource was not found, and 422 indicates validation failure or spamming.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a Repository Collaborator

ID: delete_remove_repository_collaborator
Operation: write
Entities: repository, collaborator, user
Summary: The 'Remove a Repository Collaborator' API endpoint allows an authenticated user to remove a collaborator from a specified repository. The user must be an administrator of the repository or target themselves for removal. This action cancels any outstanding invitations, unassigns the user from issues, removes access to organization projects, unstars the repository, and updates access permissions to packages. If the user had access to a fork through their membership, they will also be removed from the fork. If they had their own fork, it will be deleted. The API requires 'Administration' repository permissions (write) and supports GitHub App user access tokens, installation access tokens, and fine-grained personal access tokens. The endpoint responds with a 204 status code if successful, 403 if forbidden, and 422 if validation fails or the endpoint is spammed.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a repository from a team

ID: delete_remove_repository_from_team
Operation: write
Entities: team, repository, organization
Summary: This API endpoint allows an authenticated user who is an organization owner or a team maintainer to remove a repository from a team. The user must have admin access to the repository and be able to see the team. This operation does not delete the repository; it only removes it from the team. The request requires the organization name, team slug, repository owner, and repository name as path parameters. The 'accept' header should be set to 'application/vnd.github+json'. A successful request returns a 204 No Content status code, indicating that the repository has been successfully removed from the team.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a repository from a team (Legacy)

ID: delete_remove_repository_from_team_legacy
Operation: write
Entities: team, repository, organization
Summary: The 'Remove a repository from a team (Legacy)' API allows an authenticated user, who is either an organization owner or a team maintainer, to remove a repository from a team. This action does not delete the repository but only removes its association with the team. The API requires the team_id, owner, and repo as path parameters. The request must include an Authorization header with a bearer token. The response returns a 204 No Content status code, indicating the repository was successfully removed from the team. Note that this endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Remove a Security Manager Team

ID: delete_remove_security_manager_team
Operation: write
Entities: team, security manager, organization
Summary: The 'Remove a Security Manager Team' API endpoint allows you to delete a security manager team from an organization on GitHub. This operation requires a DELETE request to the specified URL with the organization name and team slug as path parameters. The request must include an Authorization header with a valid bearer token that has 'Administration' organization permissions (write). The API returns a 204 No Content status code upon successful deletion. Note that this operation is being deprecated and will be removed starting January 1, 2026. Users are advised to use the 'Organization Roles' endpoints instead.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Sub-Issue from an Issue

ID: delete_remove_sub_issue
Operation: write
Entities: sub-issue, repository, issue
Summary: The 'Remove Sub-Issue from an Issue' API allows users to remove a sub-issue from a specified issue in a GitHub repository. This DELETE endpoint requires the owner, repo, and issue_number as path parameters, and a sub_issue_id in the request body to identify the sub-issue to be removed. The request headers must include an Authorization token and can optionally specify the accept media type. The response includes detailed information about the issue from which the sub-issue was removed, including its ID, state, title, body, user details, labels, assignees, milestone, and more. The API supports various media types for response representation and requires specific permissions for access tokens.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Team Member (Legacy)

ID: delete_remove_team_member_legacy
Operation: write
Entities: team, member, organization
Summary: The 'Remove Team Member (Legacy)' API endpoint allows an authenticated user with 'admin' permissions to remove a member from a team in a GitHub organization. The user is not deleted, only removed from the team. This endpoint requires the 'Members' organization permissions with write access. The API uses DELETE method and requires the team_id and username as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. A successful request returns a 204 No Content status, while a 404 Not Found status is returned if team synchronization is set up.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Team Membership for a User

ID: delete_remove_team_membership_for_a_user
Operation: write
Entities: team, user, organization
Summary: The 'Remove Team Membership for a User' API allows an authenticated user with 'admin' permissions to a team or an owner of the organization to remove a user's membership from a team. This action does not delete the user, only their membership from the specified team. The API requires the organization name, team slug, and username as path parameters. The request must include an authorization bearer token in the headers. If team synchronization is set up with an organization's identity provider, attempting to use this API will result in a 403 Forbidden error. A successful request returns a 204 No Content status code, indicating the membership was successfully removed.
Input Fields: Input Fields
Output Fields: Output Fields

Remove team membership for a user (Legacy)

ID: delete_remove_team_membership_for_user_legacy
Operation: write
Entities: team, user, organization
Summary: The 'Remove team membership for a user (Legacy)' API endpoint allows an authenticated user with 'admin' permissions to remove a user's membership from a team. The endpoint is accessed via a DELETE request to the specified URL, with the team_id and username as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. A successful request returns a 204 No Content status, indicating the user has been removed from the team. If team synchronization is set up, a 403 error is returned. Note that this endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Repository Invitation

ID: delete_repository_invitation
Operation: write
Entities: repository, invitation, access token
Summary: The 'Delete a Repository Invitation' API allows users to delete an invitation to a repository. It requires a DELETE request to the specified endpoint with the repository owner's name, repository name, and invitation ID as path parameters. The request must include an Authorization header with a bearer token that has 'Administration' repository permissions (write). The API responds with a 204 No Content status code if the deletion is successful. The 'accept' header is recommended to be set to 'application/vnd.github+json'.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a repository ruleset

ID: delete_repository_ruleset
Operation: write
Entities: ruleset, repository, token
Summary: The 'Delete a repository ruleset' API allows users to delete a specific ruleset from a repository on GitHub. To use this API, the user must provide the repository owner's name, the repository name, and the ID of the ruleset to be deleted as path parameters. The request must include an Authorization header with a valid bearer token that has 'Administration' repository permissions (write). The API responds with a 204 No Content status code if the deletion is successful. If the specified ruleset is not found, a 404 Resource not found status code is returned. In case of an internal error, a 500 Internal Error status code is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Repository Webhook

ID: delete_repository_webhook
Operation: write
Entities: repository, user, webhook
Summary: The 'Delete a Repository Webhook' API allows an authenticated user with repository owner or admin access to delete a webhook from a specified repository. The user must provide the repository owner, repository name, and the unique hook ID as path parameters. The request must include an authorization header with a valid bearer token that has 'Webhooks' repository permissions set to write. The API responds with a 204 No Content status code if the webhook is successfully deleted, or a 404 Resource not found status code if the specified webhook does not exist.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a SCIM user from an organization

ID: delete_scim_user_from_organization
Operation:
Entities:
Summary: This API endpoint deletes a SCIM user from a specified organization. It requires a DELETE request to the URL with the organization name and SCIM user ID as path parameters. The request must include an Authorization header with a bearer token that has 'Members' organization permissions (write). The 'accept' header is recommended to be set to 'application/vnd.github+json'. Upon successful deletion, the API returns a 204 No Content status. Other possible response statuses include 304 Not Modified, 403 Forbidden, and 404 Resource Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Social Accounts for Authenticated User

ID: delete_social_accounts_for_authenticated_user
Operation: write
Entities: social account, profile, user
Summary: The 'Delete Social Accounts for Authenticated User' API allows the deletion of one or more social accounts from the authenticated user's profile. It requires OAuth app tokens or personal access tokens with the user scope. The endpoint accepts a DELETE request with headers including 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for the API version. The request body must contain 'account_urls', an array of strings representing the full URLs of the social media profiles to be deleted. The API responds with status codes such as 204 for successful deletion, 304 if not modified, 401 for authentication issues, 403 for forbidden access, 404 if the resource is not found, and 422 for validation failures.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an SSH signing key for the authenticated user

ID: delete_ssh_signing_key_for_authenticated_user
Operation: write
Entities: ssh signing key, token, user
Summary: This API endpoint deletes an SSH signing key from the authenticated user's GitHub account. It requires the 'admin:ssh_signing_key' scope for OAuth app tokens and personal access tokens (classic). Fine-grained access tokens must have 'SSH signing keys' user permissions set to write. The request requires the 'ssh_signing_key_id' as a path parameter and an authorization bearer token in the headers. The response will return a 204 status code if successful, indicating no content. Other possible status codes include 304 (Not modified), 401 (Requires authentication), 403 (Forbidden), and 404 (Resource not found).
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Tag Protection State for a Repository

ID: delete_tag_protection_state_for_repository
Operation: write
Entities: administrator, tag protection state, repository
Summary: This API endpoint deletes a tag protection state for a specified repository. It is only available to repository administrators and requires a fine-grained access token with 'Administration' repository permissions set to write. The endpoint is closing down and will be removed after August 30, 2024. Users are advised to use the 'Repository Rulesets' endpoint instead. The request requires the 'owner', 'repo', and 'tag_protection_id' as path parameters, and the 'Authorization' header with a bearer token. The response will return a 204 No Content status code if successful, or 403 Forbidden or 404 Resource not found if there are issues.
Input Fields: Input Fields
Output Fields: Output Fields

Unblock a User

ID: delete_unblock_a_user
Operation: write
Entities: permission, token, user
Summary: The 'Unblock a User' API endpoint allows you to unblock a specified GitHub user. It requires a DELETE request to the endpoint '/user/blocks/{username}', where '{username}' is the GitHub handle of the user to be unblocked. The request must include an 'Authorization' header with a bearer token that has 'Block another user' permissions. The 'accept' header should be set to 'application/vnd.github+json' for optimal compatibility. Upon successful unblocking, the API returns a 204 No Content status. Other possible response codes include 304 Not Modified, 401 Requires Authentication, 403 Forbidden, and 404 Resource Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

Unblock a user from an organization

ID: delete_unblock_user_from_organization
Operation: write
Entities: user, organization, access token
Summary: The 'Unblock a user from an organization' API allows an organization to unblock a specified user. This operation requires a DELETE request to the endpoint '/orgs/{org}/blocks/{username}', where 'org' is the organization name and 'username' is the GitHub user handle. The request must include an Authorization header with a bearer token that has 'Blocking users' organization permissions (write). The 'accept' header should be set to 'application/vnd.github+json'. A successful request returns a 204 No Content status, indicating that the user has been unblocked.
Input Fields: Input Fields
Output Fields: Output Fields

Unfollow a GitHub User

ID: delete_unfollow_github_user
Operation: write
Entities: permission, token, user
Summary: The 'Unfollow a GitHub User' API allows a user to unfollow another GitHub user. To use this endpoint, OAuth app tokens and personal access tokens (classic) need the user:follow scope. Fine-grained access tokens must have 'Followers' user permissions (write). The request requires the 'Authorization' header with a bearer token and the 'username' path parameter specifying the GitHub user to unfollow. The 'accept' header is recommended to be set to 'application/vnd.github+json'. A successful request returns a 204 No Content status, indicating the user has been unfollowed. Other possible responses include 304 Not Modified, 401 Requires Authentication, 403 Forbidden, and 404 Resource Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

Unlock an Issue

ID: delete_unlock_an_issue
Operation: write
Entities: conversation, repository, issue
Summary: The 'Unlock an Issue' API allows users with push access to unlock the conversation of a specified issue in a GitHub repository. The API requires DELETE method and the endpoint is '/repos/{owner}/{repo}/issues/{issue_number}/lock'. The request must include path parameters: 'owner', 'repo', and 'issue_number'. The 'accept' header should be set to 'application/vnd.github+json'. Authentication is required via a Bearer token. The API responds with a 204 status code on success, indicating no content. If the request is forbidden or the resource is not found, it returns 403 or 404 status codes respectively.
Input Fields: Input Fields
Output Fields: Output Fields

Get a GitHub User

ID: get_a_github_user
Operation: read
Entities: profile, email, user
Summary: The 'Get a GitHub User' API provides publicly available information about a GitHub user account. It requires the username as a path parameter and can optionally include headers for content type and authentication. The response includes detailed user information such as login, id, avatar URL, profile URLs, and public statistics like followers and repositories. The email field shows the publicly visible email address if set by the user. The API returns a 200 status code for successful requests and a 404 status code if the user is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Label

ID: get_a_label
Operation: read
Entities: permission, repository, label
Summary: The 'Get a Label' API retrieves a label from a specified GitHub repository using the label's name. It requires the repository owner's name, the repository name, and the label name as path parameters. The API can be accessed with or without authentication, but fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions are recommended for private resources. The response includes details about the label such as its ID, name, description, color, and whether it is a default label.
Input Fields: Input Fields
Output Fields: Output Fields

Get a milestone

ID: get_a_milestone
Operation: read
Entities: milestone, repository, user
Summary: The 'Get a milestone' API endpoint retrieves a specific milestone from a GitHub repository using the milestone number. It requires the repository owner's name, the repository name, and the milestone number as path parameters. The API can be accessed with or without authentication, but fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions are recommended for private resources. The response includes details about the milestone such as its URL, state, title, description, creator information, and issue counts. The endpoint returns a 200 status code for a successful request and a 404 status code if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get a repository

ID: get_a_repository
Operation: read
Entities: owner, repository, organization
Summary: The 'Get a repository' API endpoint retrieves detailed information about a specific GitHub repository. It requires the 'owner' and 'repo' path parameters to specify the repository. The API can be accessed without authentication for public repositories, but for private repositories or to view the 'security_and_analysis' block, appropriate permissions are required. The response includes comprehensive details about the repository, such as its name, owner, description, visibility, permissions, and more. The API supports fine-grained access tokens and returns various HTTP status codes based on the request outcome.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Team by Name

ID: get_a_team_by_name
Operation: read
Entities: team, organization
Summary: The 'Get a Team by Name' API retrieves a team using the team's slug. The slug is created by replacing special characters in the name string, converting all words to lowercase, and replacing spaces with a hyphen. The API requires the organization name and the team slug as path parameters. The response includes detailed information about the team, such as its ID, name, description, privacy settings, and associated organization details. The API returns a 200 status code for a successful request and a 404 status code if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Team Discussion (Legacy)

ID: get_a_team_discussion_legacy
Operation: read
Entities: discussion, team, user
Summary: The 'Get a Team Discussion (Legacy)' API endpoint retrieves a specific discussion from a team's page on GitHub. This endpoint requires OAuth app tokens or personal access tokens with the 'read:discussion' scope. The request must include the 'team_id' and 'discussion_number' as path parameters. The response includes details about the discussion such as the author, body content, creation date, and reactions. Note that this endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Team (Legacy)

ID: get_a_team_legacy
Operation: read
Entities: team, member, organization
Summary: The 'Get a Team (Legacy)' API endpoint retrieves information about a specific team in an organization using the team's unique identifier. This endpoint is part of the GitHub Teams API but is being deprecated. Users are encouraged to migrate to the 'Get a team by name' endpoint. The request requires a team_id as a path parameter and supports optional headers for content type and API version. The response includes detailed information about the team, such as its name, description, privacy settings, and associated organization details. The response is returned in JSON format, and the endpoint supports HTTP status codes 200 for success and 404 for resource not found.
Input Fields: Input Fields
Output Fields: Output Fields

Get all autolinks of a repository

ID: get_all_autolinks_of_a_repository
Operation: read
Entities: administrator, autolink, repository
Summary: This API endpoint retrieves all autolinks configured for a specified repository. It requires the repository owner and repository name as path parameters. The request must include an Authorization header with a bearer token that has 'Administration' repository permissions. The response is an array of autolink references, each containing an ID, key prefix, URL template, and a boolean indicating if the reference matches alphanumeric characters.
Input Fields: Input Fields
Output Fields: Output Fields

Get all custom properties for an organization

ID: get_all_custom_properties_for_an_organization
Operation: read
Entities: custom property, member, organization
Summary: This API endpoint retrieves all custom properties defined for a specified organization. It requires the organization name as a path parameter and supports authentication via various GitHub App tokens. The response includes an array of custom properties, each with details such as property name, URL, source type, value type, and other attributes. The endpoint requires 'Custom properties' organization permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

Get all custom property values for a repository

ID: get_all_custom_property_values_for_a_repository
Operation: read
Entities: custom property, repository, user
Summary: This API endpoint retrieves all custom property values set for a specified repository. Users with read access to the repository can access this endpoint. It supports fine-grained access tokens such as GitHub App user access tokens, GitHub App installation access tokens, and fine-grained personal access tokens with 'Metadata' repository permissions set to read. The endpoint can also be accessed without authentication for public resources. The request requires the 'owner' and 'repo' path parameters to specify the repository. The response is an array of objects, each containing a 'property_name' and its associated 'value'.
Input Fields: Input Fields
Output Fields: Output Fields

Get all organization repository rulesets

ID: get_all_organization_repository_rulesets
Operation: read
Entities: ruleset, repository, organization
Summary: The 'Get all organization repository rulesets' API endpoint retrieves all the repository rulesets for a specified organization. It requires the organization name as a path parameter and supports optional query parameters for pagination and filtering by rule targets. The response includes an array of rulesets, each with details such as ID, name, source type, enforcement level, and links to the ruleset. The API requires authentication via a bearer token with 'Administration' organization permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Organization Roles for an Organization

ID: get_all_organization_roles_for_an_organization
Operation: read
Entities: role, permission, organization
Summary: This API endpoint retrieves all organization roles for a specified organization on GitHub. The authenticated user must have appropriate permissions, such as being an administrator or having specific read permissions. The request requires the organization name as a path parameter and can include headers for authentication and API versioning. The response includes a list of roles with details such as role ID, name, description, permissions, and associated organization information. The response also provides timestamps for when each role was created and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Repository Rulesets

ID: get_all_repository_rulesets
Operation: read
Entities: ruleset, repository
Summary: The 'Get All Repository Rulesets' API endpoint retrieves all the rulesets for a specified repository. It requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters include 'per_page' to set the number of results per page, 'page' to specify the page number, 'includes_parents' to include rulesets from higher levels, and 'targets' to filter rulesets by specific targets. The response is an array of ruleset objects, each containing details such as 'id', 'name', 'source_type', 'source', 'enforcement', and links to the ruleset. This endpoint can be accessed with or without authentication, but fine-grained access tokens with 'Metadata' repository permissions are recommended for private resources.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Repository Topics

ID: get_all_repository_topics
Operation: read
Entities: topic, repository, token
Summary: The 'Get All Repository Topics' API endpoint retrieves all topics associated with a specified GitHub repository. It requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters 'page' and 'per_page' can be used for pagination. The request headers can include 'accept' for content type, 'Authorization' for bearer token authentication, and 'X-GitHub-Api-Version' for specifying the API version. The response includes a list of topic names associated with the repository. The endpoint supports fine-grained access tokens and can be accessed without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Organization

ID: get_an_organization
Operation: read
Entities: plan, repository, organization
Summary: The 'Get an Organization' API endpoint retrieves detailed information about a specified GitHub organization. The request requires the organization name as a path parameter, which is not case sensitive. The API can be accessed without authentication for public resources, but to view full details, the authenticated user must be an organization owner, and OAuth app tokens or personal access tokens with the 'admin:org' scope are needed. The response includes comprehensive details about the organization, such as its login, ID, URLs, description, plan, and various settings related to repositories and security. The response also indicates whether two-factor authentication is required for members. The API supports fine-grained access tokens and does not require permissions for these tokens. The response schema provides a detailed structure of the organization object returned by the API.
Input Fields: Input Fields
Output Fields: Output Fields

Get the authenticated user

ID: get_authenticated_user
Operation: read
Entities: token, user
Summary: The 'Get the authenticated user' API endpoint retrieves the details of the authenticated user on GitHub. It requires OAuth app tokens or personal access tokens with the user scope to access private profile information. The endpoint supports fine-grained access tokens, including GitHub App user access tokens and fine-grained personal access tokens, without requiring additional permissions. The API responds with a detailed user profile, including login, id, avatar URL, and other personal and public information. The response varies based on whether the user is private or public. The API returns HTTP status codes 200 for success, 304 if not modified, 401 if authentication is required, and 403 if access is forbidden.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Autolink Reference of a Repository

ID: get_autolink_reference_of_a_repository
Operation: read
Entities: autolink, token, repository
Summary: This API endpoint retrieves a single autolink reference by ID that was configured for a given repository. It requires the repository owner, repository name, and autolink ID as path parameters. The request must include an Authorization header with a bearer token. The response includes details about the autolink such as its ID, key prefix, URL template, and whether it matches alphanumeric characters. The endpoint is accessible to repository administrators with the appropriate permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Check if automated security fixes are enabled for a repository

ID: get_automated_security_fixes_status
Operation: read
Entities: security fix, repository, user
Summary: This API checks if automated security fixes are enabled, disabled, or paused for a specified repository. The authenticated user must have admin read access to the repository. The API requires a bearer token with 'Administration' repository permissions (read). The request includes path parameters for the repository owner and name, and optional headers for content type and API version. The response indicates whether automated security fixes are enabled and if they are paused.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a person is followed by the authenticated user

ID: get_check_if_followed_by_authenticated_user
Operation: read
Entities: permission, token, user
Summary: This API endpoint checks if a specified GitHub user is followed by the authenticated user. It requires a GET request to the URL 'https://api.github.com/user/following/{username}', where '{username}' is the GitHub handle of the user to check. The request must include an 'Authorization' header with a bearer token that has 'Followers' user permissions (read). The 'accept' header should be set to 'application/vnd.github+json'. If the user is followed, the response status code will be 204 with no content. If the user is not followed, the status code will be 404. Other possible status codes include 304 for not modified, 401 for authentication required, and 403 for forbidden access.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a user is blocked by an organization

ID: get_check_if_user_blocked_by_organization
Operation: read
Entities: user, organization
Summary: This API checks if a specific user is blocked by a given organization on GitHub. It requires the organization name and the GitHub username as path parameters. The request must include an authorization header with a bearer token that has 'Blocking users' organization permissions (read). If the user is blocked, the API returns a 204 status code with no content. If the user is not blocked or identified as spam, a 404 status code is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a user can be assigned to an issue in a repository

ID: get_check_if_user_can_be_assigned
Operation: read
Entities: repository, user, issue
Summary: This API checks if a user can be assigned to an issue in a specified repository. It requires the 'owner', 'repo', and 'assignee' as path parameters. The request can include headers such as 'accept', 'Authorization', and 'X-GitHub-Api-Version'. If the assignee can be assigned, a 204 status code with no content is returned. Otherwise, a 404 status code is returned. The API can be accessed with various GitHub tokens or without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a user follows another user

ID: get_check_if_user_follows_another_user
Operation: read
Entities: user
Summary: This API endpoint checks if a GitHub user follows another user. It requires the 'username' and 'target_user' as path parameters. The request can include headers such as 'accept', 'Authorization', and 'X-GitHub-Api-Version'. The endpoint returns a 204 status code if the user follows the target user and a 404 status code if not. Authentication is optional if only public resources are requested.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a User is Blocked by the Authenticated User

ID: get_check_if_user_is_blocked
Operation: read
Entities: permission, token, user
Summary: This API checks if a specified user is blocked by the authenticated user on GitHub. It requires a GET request to the endpoint '/user/blocks/{username}' with the username of the GitHub account to check. The request must include an Authorization header with a bearer token that has 'Block another user' user permissions (read). If the user is blocked, the API returns a 204 status code with no content. If the user is not blocked or the account is identified as spam, a 404 status code is returned. Other possible status codes include 304 for not modified, 401 for authentication required, and 403 for forbidden access.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a user is a repository collaborator

ID: get_check_if_user_is_repository_collaborator
Operation: read
Entities: repository, collaborator, user
Summary: This API endpoint checks if a specified user is a collaborator on a given GitHub repository. The authenticated user must have push access to the repository to use this endpoint. It requires OAuth app tokens or personal access tokens with 'read:org' and 'repo' scopes. The endpoint accepts path parameters for the repository owner, repository name, and the username of the potential collaborator. It returns a 204 status code if the user is a collaborator and a 404 status code if the user is not a collaborator. The response does not contain a body.
Input Fields: Input Fields
Output Fields: Output Fields

Check Organization Membership for a User

ID: get_check_organization_membership_for_a_user
Operation: read
Entities: organization, user, membership
Summary: The 'Check Organization Membership for a User' API endpoint allows you to verify if a user is a member of a specified GitHub organization, either publicly or privately. It requires the organization name and the GitHub username as path parameters. The endpoint can be accessed with or without authentication, but fine-grained access tokens with 'Members' organization permissions (read) are recommended for private resources. The API returns a 204 status code if the requester is an organization member and the user is a member, a 302 status code if the requester is not an organization member, and a 404 status code if the requester is an organization member but the user is not a member.
Input Fields: Input Fields
Output Fields: Output Fields

Check Public Organization Membership for a User

ID: get_check_public_organization_membership_for_a_user
Operation: read
Entities: organization, user, membership
Summary: This API checks if a specified user is a public member of a given GitHub organization. It requires the organization name and the GitHub username as path parameters. The request can include headers for 'accept', 'Authorization', and 'X-GitHub-Api-Version'. The response status code 204 indicates the user is a public member, while 404 indicates the user is not a public member. No content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Check Team Permissions for a Project

ID: get_check_team_permissions_for_a_project
Operation: read
Entities: team, project, organization
Summary: The 'Check Team Permissions for a Project' API checks whether a team has read, write, or admin permissions for a specified organization project. The API requires the organization name, team slug, and project ID as path parameters. The response includes details about the project, such as its URLs, ID, name, state, creator information, and permissions. The API returns a 200 status code if successful, and a 404 status code if the project is not managed by the specified team.
Input Fields: Input Fields
Output Fields: Output Fields

Check Team Permissions for a Project (Legacy)

ID: get_check_team_permissions_for_a_project_legacy
Operation: read
Entities: team, project, organization
Summary: The 'Check Team Permissions for a Project (Legacy)' API endpoint checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team. The API requires the 'team_id' and 'project_id' as path parameters, and it is recommended to set the 'accept' header to 'application/vnd.github+json'. The response provides detailed information about the project, including its URLs, state, creator, and permissions. Note that this endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Check Team Permissions for a Repository

ID: get_check_team_permissions_for_repository
Operation: read
Entities: permission, repository, team
Summary: The 'Check Team Permissions for a Repository' API checks whether a specified team has certain permissions (admin, push, maintain, triage, or pull) for a given repository. The API requires the organization name, team slug, repository owner, and repository name as path parameters. It also requires an authorization token with appropriate scopes. The response includes detailed information about the repository and the permissions the team has on it. If the team does not have permission, a 404 Not Found status is returned. The API can also provide additional repository information if a specific media type is set in the Accept header.
Input Fields: Input Fields
Output Fields: Output Fields

Check Team Permissions for a Repository (Legacy)

ID: get_check_team_permissions_for_repository_legacy
Operation: read
Entities: permission, repository, team
Summary: The 'Check Team Permissions for a Repository (Legacy)' API endpoint allows users to check the permissions a team has on a specified repository. This endpoint is part of the legacy Teams API and is scheduled for deprecation. It requires the team ID, repository owner, and repository name as path parameters. The API returns detailed information about the repository, including the permissions granted to the team. The response includes the repository's unique ID, name, owner details, and permission levels such as admin, pull, triage, push, and maintain. The API supports custom media types via the Accept header, with 'application/vnd.github+json' recommended.
Input Fields: Input Fields
Output Fields: Output Fields

Check if a user can be assigned to an issue

ID: get_check_user_assignment_permission
Operation: read
Entities: repository, user, issue
Summary: This API checks if a user can be assigned to a specific issue in a GitHub repository. It requires the repository owner, repository name, issue number, and assignee username as path parameters. The request can include headers for accept, authorization, and API version. If the assignee can be assigned, a 204 status code with no content is returned. Otherwise, a 404 status code is returned. The API supports fine-grained access tokens and can be used without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

List CODEOWNERS Errors

ID: get_codeowners_errors
Operation: read
Entities: codeowner, repository, error
Summary: The 'List CODEOWNERS Errors' API endpoint allows users to detect syntax errors in the CODEOWNERS file of a specified GitHub repository. It requires the 'owner' and 'repo' path parameters to specify the repository, and optionally accepts a 'ref' query parameter to specify a branch, tag, or commit. The API can be accessed with or without authentication, but requires specific permissions for private resources. The response includes a list of errors with details such as line number, column, error type, and suggestions for correction.
Input Fields: Input Fields
Output Fields: Output Fields

Get Contextual Information for a User

ID: get_contextual_information_for_a_user
Operation: read
Entities: hovercard, user, repository
Summary: The 'Get Contextual Information for a User' API provides hovercard information for a specified GitHub user. It allows you to find out more about a user in relation to their pull requests, issues, repositories, and organizations. The API requires a username as a path parameter and optionally accepts subject_type and subject_id as query parameters to provide additional context. The response includes an array of contexts with messages and octicons. The API requires an OAuth app token or personal access token with the repo scope for authentication.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Custom Property for an Organization

ID: get_custom_property_for_an_organization
Operation: read
Entities: custom property, token, organization
Summary: This API endpoint retrieves a custom property defined for an organization. Organization members can read these properties. The request requires a fine-grained access token with 'Custom properties' organization permissions set to read. The endpoint accepts headers for content type and authorization, and requires path parameters for the organization name and custom property name. The response includes details about the custom property such as its name, URL, source type, value type, whether it is required, default value, description, and allowed values.
Input Fields: Input Fields
Output Fields: Output Fields

List Custom Property Values for Organization Repositories

ID: get_custom_property_values_for_organization_repositories
Operation: read
Entities: property, repository, organization
Summary: The 'List Custom Property Values for Organization Repositories' API endpoint allows organization members to list repositories within an organization along with their custom property values. It requires a fine-grained access token with 'Custom properties' organization permissions set to read. The API accepts headers for content type and authorization, a path parameter for the organization name, and optional query parameters for pagination and repository search queries. The response includes a list of repositories with their IDs, names, full names, and associated custom properties.
Input Fields: Input Fields
Output Fields: Output Fields

Get a delivery for a repository webhook

ID: get_delivery_for_repository_webhook
Operation: read
Entities: delivery, webhook, repository
Summary: The 'Get a delivery for a repository webhook' API endpoint retrieves a specific delivery for a webhook configured in a GitHub repository. It requires the repository owner's name, repository name, hook ID, and delivery ID as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. The response includes detailed information about the delivery, such as its ID, status, event type, and associated request and response headers and payloads. The API requires fine-grained access tokens with 'Webhooks' repository permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Discussion Comment

ID: get_discussion_comment
Operation: read
Entities: discussion, comment, team
Summary: The 'Get a Discussion Comment' API retrieves a specific comment from a team discussion on GitHub. It requires the organization name, team slug, discussion number, and comment number as path parameters. The API supports OAuth app tokens and personal access tokens with the 'read:discussion' scope. The response includes details about the comment, such as the author, body, creation date, and reactions.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Discussion Comment (Legacy)

ID: get_discussion_comment_legacy
Operation: read
Entities: discussion, comment, team
Summary: The 'Get a Discussion Comment (Legacy)' API endpoint retrieves a specific comment from a team discussion on GitHub. It requires OAuth app tokens or personal access tokens with the 'read:discussion' scope. The endpoint is accessed via a GET request to the URL 'https://api.github.com/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', where 'team_id', 'discussion_number', and 'comment_number' are required path parameters. The request headers should include 'Accept' set to 'application/vnd.github+json' and an 'Authorization' bearer token. The response includes details about the comment, such as the author, body, creation date, and reactions.
Input Fields: Input Fields
Output Fields: Output Fields

Download a Repository Archive (tar)

ID: get_download_repository_archive_tar
Operation: read
Entities: tar archive, repository, user
Summary: The 'Download a Repository Archive (tar)' API provides a redirect URL to download a tar archive of a specified repository. The API requires the 'owner', 'repo', and 'ref' path parameters to identify the repository and the specific commit/branch/tag. If 'ref' is omitted, the default branch is used. The API can be accessed without authentication for public repositories, but requires a fine-grained access token with 'Contents' read permissions for private repositories. The response includes a 302 status code with a 'Location' header containing the redirect URL for downloading the archive.
Input Fields: Input Fields
Output Fields: Output Fields

Download a Repository Archive (Zip)

ID: get_download_repository_archive_zip
Operation: read
Entities: token, repository, archive
Summary: This API endpoint provides a redirect URL to download a zip archive of a specified repository. The user must specify the repository owner, name, and reference (commit/branch/tag) as path parameters. The API can be accessed without authentication for public repositories, but requires specific permissions for private repositories. The response includes a 302 status code with a 'Location' header containing the redirect URL. The 'accept' header should be set to 'application/vnd.github+json'.
Input Fields: Input Fields
Output Fields: Output Fields

List Failed Organization Invitations

ID: get_failed_organization_invitations
Operation: read
Entities: organization, user, invitation
Summary: The 'List Failed Organization Invitations' API endpoint retrieves a list of failed invitations for a specified organization on GitHub. It requires a valid authorization token with 'Members' organization permissions set to read. The request must include the organization name as a path parameter. Optional query parameters include 'per_page' to specify the number of results per page and 'page' to specify the page number of results to fetch. The response includes details about each failed invitation, such as the ID, login, email, role, creation date, failure time, and reason, as well as information about the inviter and associated teams.
Input Fields: Input Fields
Output Fields: Output Fields

List Fine-Grained Personal Access Tokens with Access to Organization Resources

ID: get_fine_grained_personal_access_tokens
Operation: read
Entities: organization, personal access token, GitHub app
Summary: This API endpoint lists approved fine-grained personal access tokens owned by organization members that can access organization resources. It is accessible only by GitHub Apps. The endpoint requires the organization name as a path parameter and supports various query parameters for filtering and pagination, such as per_page, page, sort, direction, owner, repository, permission, last_used_before, and last_used_after. The response includes details about each token, such as its ID, owner information, repository selection, permissions, and usage timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Get a GPG key for the authenticated user

ID: get_gpg_key_for_authenticated_user
Operation: read
Entities: GPG key, user, access token
Summary: This API endpoint retrieves a GPG key for the authenticated user. It requires a GET request to the URL 'https://api.github.com/user/gpg_keys/{gpg_key_id}', where 'gpg_key_id' is a required path parameter representing the unique identifier of the GPG key. The request headers should include an 'Authorization' header with a Bearer token for authentication, and it is recommended to set the 'Accept' header to 'application/vnd.github+json'. The response includes detailed information about the GPG key, such as its ID, name, key ID, public key, associated emails, subkeys, and various permissions and statuses. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get a hosted compute network configuration for an organization

ID: get_hosted_compute_network_configuration_for_an_organization
Operation: read
Entities: network configuration, token, organization
Summary: This API endpoint retrieves a hosted compute network configuration for a specified organization. It requires OAuth app tokens or personal access tokens with the read:network_configurations scope. The request must include the organization name and the unique identifier of the network configuration as path parameters. The response includes details such as the configuration's ID, name, supported compute service, network settings IDs, and creation date.
Input Fields: Input Fields
Output Fields: Output Fields

List Hosted Compute Network Configurations for an Organization

ID: get_hosted_compute_network_configurations
Operation: read
Entities: network configuration, organization, compute service
Summary: This API endpoint lists all hosted compute network configurations configured in a specified organization. It requires OAuth app tokens or personal access tokens with the read:network_configurations scope. The request includes headers for accept, authorization, and optionally the GitHub API version. The path parameter 'org' is required to specify the organization name. Optional query parameters 'per_page' and 'page' control pagination. The response includes a total count of configurations and an array of network configuration objects, each with details such as id, name, compute service, network settings ids, and creation date.
Input Fields: Input Fields
Output Fields: Output Fields

Get a hosted compute network settings resource for an organization

ID: get_hosted_compute_network_settings_resource
Operation: read
Entities: network configuration, organization, network setting
Summary: This API endpoint retrieves a hosted compute network settings resource configured for a specified organization. It requires OAuth app tokens or personal access tokens with the read:network_configurations scope. The request must include the organization name and the unique identifier of the network settings as path parameters. The response includes details such as the unique identifier of the network settings resource, the network configuration ID, the name of the resource, the subnet ID, and the region.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Issue Comment

ID: get_issue_comment
Operation: read
Entities: comment, repository, issue
Summary: The 'Get an Issue Comment' API allows users to retrieve comments on issues and pull requests from a GitHub repository. The API requires the owner of the repository, the repository name, and the unique comment ID as path parameters. The request can include headers for media type specification and authentication. The response includes details about the comment such as its ID, URL, body content, user information, and timestamps. The API supports various media types to return the comment body in different formats, including raw markdown, text, and HTML.
Input Fields: Input Fields
Output Fields: Output Fields

Get an issue event

ID: get_issue_event
Operation: read
Entities: event, repository, issue
Summary: The 'Get an issue event' API retrieves a single event by its event ID from a specified repository on GitHub. It requires the path parameters 'owner', 'repo', and 'event_id' to identify the repository and the specific event. The API can be accessed with or without authentication, but fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions are recommended for private resources. The response includes detailed information about the event, such as the actor, event type, commit details, and associated issue information. The API returns a 200 status code for a successful request, while 403, 404, and 410 status codes indicate various errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Issue from a GitHub Repository

ID: get_issue_from_github_repository
Operation: read
Entities: repository, user, issue
Summary: The 'Get an Issue from a GitHub Repository' API endpoint allows users to retrieve detailed information about a specific issue in a GitHub repository. The endpoint requires the repository owner, repository name, and issue number as path parameters. It supports various media types for the response, including raw, text, HTML, and full representations of the issue body. The response includes comprehensive details about the issue, such as its ID, state, title, body, user information, labels, assignees, milestone, comments, and pull request details if applicable. The API can be accessed without authentication for public resources, but fine-grained access tokens with 'Issues' repository permissions are required for private resources. The endpoint returns different HTTP status codes based on the issue's state, such as 200 for success, 301 if moved, 404 if not found, and 410 if gone.
Input Fields: Input Fields
Output Fields: Output Fields

List App Installations for an Organization

ID: get_list_app_installations_for_an_organization
Operation: read
Entities: installation, app, organization
Summary: The 'List App Installations for an Organization' API endpoint allows users to list all GitHub Apps installed on repositories within a specified organization. The authenticated user must be an organization owner and have the appropriate OAuth app tokens or personal access tokens with the 'admin:read' scope. The API requires the organization name as a path parameter and supports pagination through query parameters 'per_page' and 'page'. The response includes a total count of installations and detailed information about each installation, such as the installation ID, account details, repository selection, permissions, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Assignees for Repository Issues

ID: get_list_assignees_for_repository_issues
Operation: read
Entities: assignee, repository, user
Summary: The 'List Assignees for Repository Issues' API endpoint allows users to retrieve a list of available assignees for issues in a specified GitHub repository. The endpoint requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters 'per_page' and 'page' can be used for pagination. The API can be accessed with or without authentication, but fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions are recommended for private resources. The response includes an array of user objects, each containing details such as login, id, avatar_url, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Attestations

ID: get_list_attestations
Operation: read
Entities: attestation, repository, signature
Summary: The 'List Attestations' API endpoint retrieves a collection of artifact attestations associated with a repository, identified by a subject digest. The authenticated user must have read access to the repository, and specific permissions are required when using fine-grained access tokens. The endpoint supports pagination through 'per_page', 'before', and 'after' query parameters. The response includes an array of attestations, each containing a Sigstore Bundle, repository ID, and bundle URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Child Teams

ID: get_list_child_teams
Operation: read
Entities: team, organization
Summary: The 'List Child Teams' API endpoint retrieves the child teams of a specified team within an organization. It requires the organization name and team slug as path parameters. The API supports pagination through 'per_page' and 'page' query parameters. The response includes an array of team objects, each containing details such as team ID, name, description, privacy settings, and parent team information. The API requires an authorization token in the headers for access.
Input Fields: Input Fields
Output Fields: Output Fields

List Child Teams (Legacy)

ID: get_list_child_teams_legacy
Operation: read
Entities: team, repository, organization
Summary: The 'List Child Teams (Legacy)' API endpoint retrieves a list of child teams for a specified team within an organization. It requires the 'team_id' as a path parameter to identify the team. The API supports pagination through 'per_page' and 'page' query parameters. The response includes details about each child team, such as 'id', 'name', 'description', 'privacy', and 'permission'. The endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

List deliveries for a repository webhook

ID: get_list_deliveries_for_a_repository_webhook
Operation: read
Entities: delivery, webhook, repository
Summary: The 'List deliveries for a repository webhook' API returns a list of webhook deliveries for a specified webhook configured in a repository. It requires the 'owner', 'repo', and 'hook_id' as path parameters. The API supports pagination through 'per_page' and 'cursor' query parameters. The response includes details such as delivery ID, GUID, delivery time, status, event type, and more. The API requires authentication via a bearer token with 'Webhooks' repository permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

List Deliveries for an Organization Webhook

ID: get_list_deliveries_for_an_organization_webhook
Operation: read
Entities: webhook, delivery, organization
Summary: The 'List Deliveries for an Organization Webhook' API endpoint returns a list of webhook deliveries for a specified webhook configured in an organization. To use this endpoint, the user must be an organization owner and have the appropriate OAuth app tokens or personal access tokens with 'admin:org_hook' scope. The endpoint supports fine-grained access tokens with 'Webhooks' organization permissions set to read. The request requires the organization name and hook ID as path parameters. Optional query parameters include 'per_page' for the number of results per page and 'cursor' for pagination. The response is an array of webhook delivery objects, each containing details such as delivery ID, event GUID, delivery time, status, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Discussion Comments

ID: get_list_discussion_comments
Operation: read
Entities: discussion, team, organization
Summary: The 'List Discussion Comments' API allows users to retrieve all comments on a specific team discussion within an organization on GitHub. The API requires the organization name, team slug, and discussion number as path parameters. Optional query parameters include the direction to sort results, the number of results per page, and the page number to fetch. The API returns an array of comments, each containing details about the author, comment body, creation and update timestamps, and reactions. Authentication is required via OAuth or personal access tokens with the 'read:discussion' scope.
Input Fields: Input Fields
Output Fields: Output Fields

List Discussion Comments (Legacy)

ID: get_list_discussion_comments_legacy
Operation: read
Entities: discussion, comment, team
Summary: The 'List Discussion Comments (Legacy)' API endpoint retrieves all comments on a specific team discussion. It requires OAuth app tokens or personal access tokens with the 'read:discussion' scope. The endpoint is accessed via a GET request to 'https://api.github.com/teams/{team_id}/discussions/{discussion_number}/comments'. The request must include the 'team_id' and 'discussion_number' as path parameters. Optional query parameters include 'direction' for sorting, 'per_page' for the number of results per page, and 'page' for pagination. The response is an array of comments, each containing details such as the author, body, creation date, and reactions. Note that this endpoint is being deprecated, and users are advised to migrate to the new endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

List Discussions (Legacy)

ID: get_list_discussions_legacy
Operation: read
Entities: discussion, team, user
Summary: The 'List Discussions (Legacy)' API endpoint allows users to list all discussions on a team's page. It requires OAuth app tokens or personal access tokens with the 'read:discussion' scope. The endpoint is accessed via a GET request to 'https://api.github.com/teams/{team_id}/discussions'. The request headers should include 'accept' set to 'application/vnd.github+json', and an 'Authorization' bearer token. The 'team_id' is a required path parameter. Optional query parameters include 'direction' for sorting (default 'desc'), 'per_page' for the number of results per page (default 30), and 'page' for the page number (default 1). The response is an array of discussion objects, each containing details such as the author, body, comments count, creation date, and reactions.
Input Fields: Input Fields
Output Fields: Output Fields

List Email Addresses for Authenticated User

ID: get_list_email_addresses_for_authenticated_user
Operation: read
Entities: email address, token, user
Summary: This API endpoint lists all email addresses associated with the authenticated user on GitHub. It specifies which email is visible to the public. The endpoint requires OAuth app tokens or personal access tokens with the 'user:email' scope. Fine-grained access tokens must have 'Email addresses' user permissions set to read. The request can include headers for content type and authorization, and query parameters for pagination. The response is an array of email objects, each containing the email address, verification status, primary status, and visibility.
Input Fields: Input Fields
Output Fields: Output Fields

List Followers of a User

ID: get_list_followers_of_a_user
Operation: read
Entities: follower, user, GitHub app
Summary: The 'List Followers of a User' API endpoint allows you to retrieve a list of users who are following a specified GitHub user. The endpoint requires the 'username' path parameter to specify the GitHub user account. Optional query parameters 'per_page' and 'page' can be used for pagination, with defaults set to 30 results per page and starting at page 1. The response is an array of user objects, each containing details such as login, id, avatar_url, and more. Authentication is optional unless accessing private resources, and the recommended header 'accept' should be set to 'application/vnd.github+json'.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of the authenticated user

ID: get_list_followers_of_authenticated_user
Operation: read
Entities: follower, github app, user
Summary: The 'List followers of the authenticated user' API endpoint allows the authenticated user to retrieve a list of people who are following them on GitHub. The request requires an authorization header with a bearer token that has 'Followers' user permissions set to read. The API supports pagination through 'per_page' and 'page' query parameters, with defaults set to 30 results per page and starting at page 1. The response is an array of user objects, each containing details such as login, id, avatar URL, and various GitHub URLs related to the user.
Input Fields: Input Fields
Output Fields: Output Fields

List Forks of a Repository

ID: get_list_forks_of_a_repository
Operation: read
Entities: repository, user, license
Summary: The 'List Forks of a Repository' API endpoint allows users to retrieve a list of forks for a specified GitHub repository. The endpoint requires the 'owner' and 'repo' path parameters to identify the repository. Optional query parameters include 'sort' to determine the order of results, 'per_page' to specify the number of results per page, and 'page' to select the page of results. The response is an array of repository objects, each containing detailed information about the fork, such as its ID, name, owner, and various URLs. The API can be accessed without authentication for public repositories, but fine-grained access tokens with 'Metadata' repository permissions are required for private resources.
Input Fields: Input Fields
Output Fields: Output Fields

List GPG keys for a user

ID: get_list_gpg_keys_for_a_user
Operation: read
Entities: gpg key, user, access token
Summary: The 'List GPG keys for a user' API endpoint allows users to retrieve the GPG keys associated with a specified GitHub user account. This endpoint is accessible to anyone and does not require any specific permissions for fine-grained tokens. The request requires the 'username' path parameter to specify the GitHub user. Optional query parameters include 'per_page' to set the number of results per page (default is 30, max is 100) and 'page' to specify the page number of results to fetch (default is 1). The response returns an array of GPG key objects, each containing details such as 'id', 'name', 'key_id', 'public_key', 'emails', 'subkeys', and various boolean flags indicating the capabilities of the key. The response also includes timestamps for creation and expiration, as well as a 'revoked' status.
Input Fields: Input Fields
Output Fields: Output Fields

List GPG keys for the authenticated user

ID: get_list_gpg_keys_for_authenticated_user
Operation: read
Entities: gpg key, token, user
Summary: This API endpoint lists the GPG keys for the authenticated user. It requires OAuth app tokens or personal access tokens with the 'read:gpg_key' scope. The endpoint supports fine-grained access tokens with 'GPG keys' user permissions set to read. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for API versioning. Query parameters 'per_page' and 'page' can be used for pagination. The response includes an array of GPG keys, each with details like id, name, key_id, public_key, associated emails, subkeys, and permissions like can_sign, can_encrypt_comms, can_encrypt_storage, and can_certify.
Input Fields: Input Fields
Output Fields: Output Fields

List Issue Comments

ID: get_list_issue_comments
Operation: read
Entities: comment, repository, issue
Summary: The 'List Issue Comments' API endpoint allows users to retrieve comments on issues and pull requests within a GitHub repository. The endpoint requires the repository owner's name, the repository name, and the issue number as path parameters. Optional query parameters include 'since' to filter comments updated after a specific time, 'per_page' to specify the number of results per page, and 'page' to select the page number of results. The API supports various media types to return the comment body in different formats. The response includes details about each comment, such as the comment ID, URL, body content, user information, creation and update timestamps, and the author's association with the repository. The API can be accessed with or without authentication, depending on whether public or private resources are requested.
Input Fields: Input Fields
Output Fields: Output Fields

List Issue Comments for a Repository

ID: get_list_issue_comments_for_a_repository
Operation: read
Entities: comment, repository, issue
Summary: The 'List Issue Comments for a Repository' API endpoint allows users to retrieve comments on issues and pull requests for a specified repository. The endpoint requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters include 'sort', 'direction', 'since', 'per_page', and 'page' to customize the results. The API supports various media types for the response, including raw markdown, text, and HTML representations. The response includes details about each comment, such as the comment ID, URL, body, user information, creation and update timestamps, and author association. The endpoint can be accessed without authentication for public resources, but fine-grained access tokens are required for private resources.
Input Fields: Input Fields
Output Fields: Output Fields

List Issue Events

ID: get_list_issue_events
Operation: read
Entities: event, repository, issue
Summary: The 'List Issue Events' API endpoint retrieves all events for a specific issue in a GitHub repository. It requires the 'owner', 'repo', and 'issue_number' as path parameters. Optional query parameters include 'per_page' and 'page' for pagination. The API can be accessed with or without authentication, but fine-grained access tokens with specific permissions are recommended for private resources. The response includes an array of events, each with details such as the event ID, actor information, event type, commit details, and associated labels.
Input Fields: Input Fields
Output Fields: Output Fields

List issue events for a repository

ID: get_list_issue_events_for_a_repository
Operation: read
Entities: event, repository, issue
Summary: The 'List issue events for a repository' API endpoint allows users to retrieve a list of events for a specific repository on GitHub. This endpoint can be accessed using a GET request to the URL 'https://api.github.com/repos/{owner}/{repo}/issues/events', where 'owner' is the account owner of the repository and 'repo' is the name of the repository. The API supports optional query parameters 'per_page' and 'page' for pagination. The response includes detailed information about each event, such as the event ID, URL, actor details, event type, associated commit, and issue details. The API can be accessed without authentication for public resources, but fine-grained access tokens with 'Issues' repository permissions are required for private resources.
Input Fields: Input Fields
Output Fields: Output Fields

List issues assigned to the authenticated user

ID: get_list_issues_assigned_to_authenticated_user
Operation: read
Entities: repository, user, issue
Summary: The 'List issues assigned to the authenticated user' API endpoint allows users to retrieve a list of issues assigned to them across all visible repositories, including owned, member, and organization repositories. The endpoint can also fetch issues not necessarily assigned to the user by using the 'filter' query parameter. The API considers every pull request as an issue, but not every issue is a pull request. The response can include both issues and pull requests, identifiable by the 'pull_request' key. The API supports various custom media types for different representations of the markdown body. The endpoint requires an authorization token and supports several query parameters to filter and sort the results, such as 'filter', 'state', 'labels', 'sort', 'direction', 'since', 'collab', 'orgs', 'owned', 'pulls', 'per_page', and 'page'. The response includes detailed information about each issue, such as its ID, URL, state, title, body, user, labels, assignees, milestone, comments, pull request details, and repository information.
Input Fields: Input Fields
Output Fields: Output Fields

List labels for a repository

ID: get_list_labels_for_a_repository
Operation: read
Entities: token, repository, label
Summary: The 'List labels for a repository' API endpoint allows users to retrieve all labels associated with a specific GitHub repository. It requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters 'per_page' and 'page' can be used for pagination. The API can be accessed with or without authentication, but fine-grained access tokens with specific permissions are recommended for private resources. The response includes an array of label objects, each containing details such as 'id', 'name', 'description', 'color', and 'default' status.
Input Fields: Input Fields
Output Fields: Output Fields

List labels for an issue

ID: get_list_labels_for_an_issue
Operation: read
Entities: repository, label, issue
Summary: The 'List labels for an issue' API endpoint retrieves all labels associated with a specific issue in a GitHub repository. It requires the 'owner', 'repo', and 'issue_number' as path parameters. Optional query parameters include 'per_page' and 'page' for pagination. The API can be accessed with or without authentication, but fine-grained access tokens with 'Issues' or 'Pull requests' repository permissions are recommended for private resources. The response is an array of label objects, each containing details like 'id', 'name', 'description', 'color', and 'default' status.
Input Fields: Input Fields
Output Fields: Output Fields

List labels for issues in a milestone

ID: get_list_labels_for_issues_in_a_milestone
Operation: read
Entities: milestone, repository, label
Summary: The 'List labels for issues in a milestone' API endpoint allows users to retrieve labels associated with issues in a specific milestone within a GitHub repository. It requires the repository owner's username, the repository name, and the milestone number as path parameters. The API supports optional query parameters for pagination, including 'per_page' to specify the number of results per page and 'page' to specify the page number. The response is an array of label objects, each containing details such as the label's ID, name, description, color, and whether it is a default label. Authentication is optional but recommended for accessing private resources.
Input Fields: Input Fields
Output Fields: Output Fields

List Milestones for a Repository

ID: get_list_milestones_for_a_repository
Operation: read
Entities: milestone, repository, user
Summary: The 'List Milestones for a Repository' API endpoint allows users to retrieve a list of milestones for a specified GitHub repository. The request requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters include 'state', 'sort', 'direction', 'per_page', and 'page' to filter and paginate the results. The response is an array of milestone objects, each containing details such as the milestone's URL, state, title, description, creator, and associated issues. This endpoint can be accessed with or without authentication, depending on whether public or private resources are requested.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Invitation Teams

ID: get_list_organization_invitation_teams
Operation: read
Entities: organization, team, invitation
Summary: The 'List Organization Invitation Teams' API endpoint allows users to list all teams associated with a specific invitation in an organization. To access this endpoint, the authenticated user must be an organization owner. The endpoint supports fine-grained access tokens, including GitHub App user access tokens, GitHub App installation access tokens, and fine-grained personal access tokens with 'Members' organization permissions (read). The request requires the organization name and invitation ID as path parameters. Optional query parameters include 'per_page' for the number of results per page and 'page' for the page number of results. The response includes an array of teams, each with details such as ID, name, description, privacy, and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Issues Assigned to Authenticated User

ID: get_list_organization_issues_assigned_to_authenticated_user
Operation: read
Entities: pull request, organization, issue
Summary: The 'List Organization Issues Assigned to Authenticated User' API endpoint allows users to retrieve a list of issues within a specified organization that are assigned to the authenticated user. The endpoint considers both issues and pull requests, as GitHub treats pull requests as issues. Users can filter the results based on various criteria such as issue state, labels, sort order, and more. The API requires an organization name as a path parameter and supports various query parameters for filtering and pagination. The response includes detailed information about each issue, including its state, title, associated labels, assignees, and more. The API supports different media types for the response body, allowing users to choose between raw, text, HTML, or full representations of the markdown body.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Members

ID: get_list_organization_members
Operation: read
Entities: permission, user, organization
Summary: The 'List Organization Members' API endpoint allows users to retrieve a list of all members within a specified GitHub organization. If the authenticated user is a member of the organization, both public and concealed members will be returned. The endpoint supports fine-grained access tokens, including GitHub App user access tokens, installation access tokens, and personal access tokens with 'Members' organization permissions set to read. The API can also be accessed without authentication for public resources. The request requires the organization name as a path parameter and supports optional query parameters to filter results by two-factor authentication status, role, and pagination settings. The response includes an array of user objects, each containing details such as login, id, avatar URL, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Memberships for Authenticated User

ID: get_list_organization_memberships_for_authenticated_user
Operation: read
Entities: organization, user, membership
Summary: The 'List Organization Memberships for Authenticated User' API endpoint retrieves all organization memberships for the authenticated user. It requires a bearer token for authentication and supports fine-grained access tokens. The API accepts optional query parameters such as 'state' to filter memberships by their state (active or pending), 'per_page' to specify the number of results per page, and 'page' to indicate the page number of results to fetch. The response is an array of organization membership objects, each containing details about the membership state, role, organization, and user information. The API returns HTTP status codes 200 for success, 304 for not modified, 401 for authentication required, 403 for forbidden access, and 422 for validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Repositories

ID: get_list_organization_repositories
Operation: read
Entities: repository, user, organization
Summary: The 'List Organization Repositories' API endpoint allows users to list repositories for a specified organization on GitHub. It supports various fine-grained access tokens and requires 'Metadata' repository permissions for private resources. The endpoint can be accessed without authentication for public resources. The request includes headers for content type and optional authentication, a required path parameter for the organization name, and optional query parameters to filter and sort the results. The response returns an array of repository objects, each containing detailed information about the repository, including its owner, visibility, permissions, and security settings.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Rule Suites

ID: get_list_organization_rule_suites
Operation: read
Entities: repository, rule suite, organization
Summary: The 'List Organization Rule Suites' API endpoint allows users to list suites of rule evaluations at the organization level. It requires an organization name as a path parameter and supports various query parameters to filter the results, such as ref, repository_name, time_period, actor_name, rule_suite_result, per_page, and page. The API requires a Bearer token for authentication with 'Administration' organization permissions. The response includes an array of rule suite objects, each containing details like id, actor_id, actor_name, before_sha, after_sha, ref, repository_id, repository_name, pushed_at, result, and evaluation_result.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Webhooks

ID: get_list_organization_webhooks
Operation: read
Entities: webhook, user, organization
Summary: The 'List Organization Webhooks' API endpoint allows an authenticated user, who must be an organization owner, to list webhooks for a specified organization. The user must have the 'admin:org_hook' scope for OAuth app tokens and personal access tokens. The endpoint supports fine-grained access tokens with 'Webhooks' organization permissions (read). The request requires the organization name as a path parameter and supports pagination through 'per_page' and 'page' query parameters. The response returns an array of webhook objects, each containing details such as id, url, events, and configuration.
Input Fields: Input Fields
Output Fields: Output Fields

List Organizations

ID: get_list_organizations
Operation: read
Entities: organization
Summary: The 'List Organizations' API endpoint allows users to retrieve a list of all organizations in the order they were created. It supports pagination through the 'since' query parameter and can return a specified number of results per page using the 'per_page' parameter. The API can be accessed with various fine-grained access tokens, including GitHub App user access tokens, installation access tokens, and personal access tokens, though no permissions are required for these tokens. The endpoint can also be used without authentication for public resources. The response includes details about each organization, such as login, ID, URLs for various resources, avatar URL, and description.
Input Fields: Input Fields
Output Fields: Output Fields

List organizations for a user

ID: get_list_organizations_for_a_user
Operation: read
Entities: organization, user, membership
Summary: The 'List organizations for a user' API endpoint retrieves public organization memberships for a specified GitHub user. It only lists public memberships, regardless of authentication. The endpoint supports fine-grained access tokens, including GitHub App user access tokens, GitHub App installation access tokens, and fine-grained personal access tokens, but does not require any permissions. The endpoint can be accessed without authentication if only public resources are requested. The request requires a 'username' path parameter and supports optional query parameters 'per_page' and 'page' for pagination. The response returns an array of organizations, each containing details such as 'login', 'id', 'url', 'repos_url', 'events_url', 'hooks_url', 'issues_url', 'members_url', 'public_members_url', 'avatar_url', and 'description'.
Input Fields: Input Fields
Output Fields: Output Fields

List Organizations for Authenticated User

ID: get_list_organizations_for_authenticated_user
Operation: read
Entities: user, organization
Summary: This API endpoint lists organizations for the authenticated user. It requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). The endpoint returns a list of organizations that the user is authorized to operate on. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for specifying the API version. Query parameters 'per_page' and 'page' can be used for pagination. The response includes details about each organization such as login, id, node_id, URLs for various resources, avatar URL, and description.
Input Fields: Input Fields
Output Fields: Output Fields

List Outside Collaborators for an Organization

ID: get_list_outside_collaborators_for_an_organization
Operation: read
Entities: user, collaborator, organization
Summary: The 'List Outside Collaborators for an Organization' API endpoint allows you to retrieve a list of users who are outside collaborators of a specified GitHub organization. The request requires an organization name as a path parameter and supports optional query parameters to filter results, specify the number of results per page, and select the page number. The response is an array of user objects, each containing details such as login, id, avatar URL, and more. The API requires authentication via a bearer token with 'Members' organization permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

List Pending Team Invitations

ID: get_list_pending_team_invitations
Operation: read
Entities: organization, team, invitation
Summary: The 'List Pending Team Invitations' API retrieves a list of pending invitations for a specified team within an organization on GitHub. The API requires the organization name and team slug as path parameters. It supports optional query parameters for pagination, including 'per_page' to specify the number of results per page and 'page' to specify the page number. The response includes details about each invitation, such as the invitee's login, email, role, and the inviter's information. The role field indicates the type of invitation, which can be 'direct_member', 'admin', 'billing_manager', 'hiring_manager', or 'reinstate'. If the invitee is not a GitHub member, the login field will be null.
Input Fields: Input Fields
Output Fields: Output Fields

List Pending Team Invitations (Legacy)

ID: get_list_pending_team_invitations_legacy
Operation: read
Entities: team, user, invitation
Summary: The 'List Pending Team Invitations (Legacy)' API endpoint retrieves a list of pending invitations for a specified team. This endpoint is part of the GitHub Teams API and is being deprecated. Users are encouraged to migrate to the new endpoint. The API requires a team_id as a path parameter, which is the unique identifier of the team. Optional query parameters include 'per_page' to specify the number of results per page (default is 30, max is 100) and 'page' to specify the page number of results to fetch (default is 1). The response includes an array of invitation objects, each containing details such as the invitee's login, email, role, and inviter information. The role can be one of several values, including 'direct_member', 'admin', 'billing_manager', 'hiring_manager', or 'reinstate'. If the invitee is not a GitHub member, the login field will be null.
Input Fields: Input Fields
Output Fields: Output Fields

List Public Email Addresses for Authenticated User

ID: get_list_public_email_addresses_for_authenticated_user
Operation: read
Entities: email address, user, permission
Summary: This API endpoint lists the publicly visible email addresses for the authenticated user. It requires OAuth app tokens or personal access tokens with the user:email scope. The endpoint can also be accessed without authentication if only public resources are requested. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for bearer token authentication, and 'X-GitHub-Api-Version' for specifying the API version. Query parameters 'per_page' and 'page' can be used for pagination. The response is an array of email objects, each containing the email address, its verification status, whether it is primary, and its visibility.
Input Fields: Input Fields
Output Fields: Output Fields

List public keys for a user

ID: get_list_public_keys_for_a_user
Operation: read
Entities: public key, user, access token
Summary: The 'List public keys for a user' API endpoint retrieves the verified public SSH keys for a specified GitHub user. It is accessible by anyone and can be used without authentication if only public resources are requested. The endpoint requires the 'username' path parameter to specify the GitHub user account. Optional query parameters include 'per_page' to set the number of results per page (default is 30, max is 100) and 'page' to specify the page number of results (default is 1). The response is an array of objects, each containing an 'id' and 'key' representing the public SSH keys. The API can be accessed using fine-grained access tokens with 'Git SSH keys' user permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

List Public Organization Members

ID: get_list_public_organization_members
Operation: read
Entities: member, organization, access token
Summary: The 'List Public Organization Members' API endpoint retrieves a list of members of a specified organization who have chosen to publicize their membership. It requires the organization name as a path parameter and supports optional query parameters for pagination, such as 'per_page' and 'page'. The API can be accessed without authentication if only public resources are requested, but fine-grained access tokens with 'Members' organization permissions (read) are recommended for authenticated access. The response includes an array of user objects, each containing details like login, id, avatar URL, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Public Repositories

ID: get_list_public_repositories
Operation: read
Entities: repository, user
Summary: The 'List Public Repositories' API endpoint allows users to retrieve a list of all public repositories on GitHub in the order they were created. This endpoint can be accessed without authentication if only public resources are requested. It supports pagination through the 'since' query parameter, which specifies a repository ID to return repositories with an ID greater than the specified value. The response includes detailed information about each repository, such as its ID, name, owner details, and URLs. The API also supports fine-grained access tokens with 'Metadata' repository permissions for authenticated requests.
Input Fields: Input Fields
Output Fields: Output Fields

List public SSH keys for the authenticated user

ID: get_list_public_ssh_keys_for_authenticated_user
Operation: read
Entities: ssh key, token, user
Summary: This API endpoint lists the public SSH keys for the authenticated user's GitHub account. It requires OAuth app tokens or personal access tokens with the 'read:public_key' scope. The endpoint supports fine-grained access tokens with 'Git SSH keys' user permissions set to read. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for specifying the API version. Query parameters 'per_page' and 'page' can be used for pagination. The response is an array of SSH key objects, each containing details like 'key', 'id', 'url', 'title', 'created_at', 'verified', and 'read_only'.
Input Fields: Input Fields
Output Fields: Output Fields

List Repositories for a User

ID: get_list_repositories_for_a_user
Operation: read
Entities: repository, user, access token
Summary: The 'List Repositories for a User' API endpoint allows users to retrieve a list of public repositories for a specified GitHub user. The endpoint can be accessed without authentication if only public resources are requested. It supports fine-grained access tokens such as GitHub App user access tokens, GitHub App installation access tokens, and fine-grained personal access tokens with 'Metadata' repository permissions set to read. The API requires the 'username' path parameter to specify the GitHub user account. Optional query parameters include 'type' to filter repositories by type, 'sort' to determine the sorting property, 'direction' to set the sorting order, 'per_page' to specify the number of results per page, and 'page' to indicate the page number of results. The response is an array of repository objects, each containing details such as repository ID, name, owner information, visibility, and various URLs related to the repository.
Input Fields: Input Fields
Output Fields: Output Fields

List Repositories for Authenticated User

ID: get_list_repositories_for_authenticated_user
Operation: read
Entities: repository, user, organization
Summary: The 'List Repositories for Authenticated User' API endpoint allows the authenticated user to list repositories they have explicit permission to access. This includes repositories they own, are a collaborator on, or can access through an organization membership. The API supports fine-grained access tokens and can be used without authentication for public resources. The request can include headers for content type and authorization, and query parameters to filter results by visibility, affiliation, type, sort order, pagination, and update timestamps. The response returns an array of repository objects, each containing detailed information about the repository, including its owner, visibility, permissions, and various URLs related to the repository.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Activities

ID: get_list_repository_activities
Operation: read
Entities: activity, user, repository
Summary: The 'List Repository Activities' API endpoint provides a detailed history of changes to a GitHub repository, including pushes, merges, force pushes, and branch changes. It associates these changes with commits and users. The endpoint requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters include 'direction', 'per_page', 'before', 'after', 'ref', 'actor', 'time_period', and 'activity_type' to filter and sort the results. The API can be accessed with or without authentication, but fine-grained access tokens with 'Contents' repository permissions (read) are recommended for private resources. The response includes an array of activity objects, each detailing the activity type, associated commits, and the actor involved.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Collaborators

ID: get_list_repository_collaborators
Operation: read
Entities: repository, collaborator, organization
Summary: The 'List Repository Collaborators' API endpoint retrieves a list of collaborators for a specified repository. For organization-owned repositories, this includes outside collaborators, organization members with direct collaboration, and those with access through team memberships or default organization permissions. The authenticated user must have push access to the repository to use this endpoint. The API requires OAuth app tokens or personal access tokens with 'read:org' and 'repo' scopes. The endpoint supports fine-grained access tokens with 'Metadata' repository permissions. The request includes headers for authentication and API versioning, path parameters for the repository owner and name, and optional query parameters to filter collaborators by affiliation, permission, and pagination. The response returns an array of collaborator objects, each containing details such as login, id, avatar URL, and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Contributors

ID: get_list_repository_contributors
Operation: read
Entities: repository, user, contributor
Summary: The 'List Repository Contributors' API endpoint lists contributors to a specified GitHub repository, sorting them by the number of commits per contributor in descending order. It identifies contributors by author email address and groups contribution counts by GitHub user. The endpoint supports fine-grained access tokens and can be used without authentication for public resources. Required path parameters include 'owner' and 'repo', while optional query parameters include 'anon', 'per_page', and 'page'. The response includes an array of contributor objects with details such as 'login', 'id', 'avatar_url', and 'contributions'.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Invitations

ID: get_list_repository_invitations
Operation: read
Entities: repository, user, invitation
Summary: The 'List Repository Invitations' API endpoint allows users with admin rights to a repository to list all currently open repository invitations. It requires authentication via a bearer token and supports fine-grained access tokens with 'Administration' repository permissions set to read. The endpoint accepts path parameters for the repository owner and name, and optional query parameters for pagination. The response includes an array of repository invitations, each containing details about the invitation, repository, invitee, and inviter.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Issues

ID: get_list_repository_issues
Operation: read
Entities: pull request, repository, issue
Summary: The 'List Repository Issues' API endpoint allows users to list issues in a specified GitHub repository. It returns only open issues by default, but can be configured to return closed or all issues using query parameters. The endpoint supports various filters such as milestone, state, assignee, creator, mentioned user, labels, sort order, and pagination. The response includes detailed information about each issue, including its ID, state, title, body, user details, labels, assignees, milestone, comments, and associated pull request if applicable. The API can be accessed without authentication for public repositories, but requires appropriate permissions for private repositories.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Languages

ID: get_list_repository_languages
Operation: read
Entities: language, repository, token
Summary: The 'List Repository Languages' API endpoint lists the programming languages used in a specified GitHub repository. It returns the number of bytes of code written in each language. The endpoint requires the 'owner' and 'repo' path parameters to specify the repository. It can be accessed with or without authentication, but fine-grained access tokens with 'Metadata' repository permissions are recommended for private resources. The response is a JSON object where keys are language names and values are the number of bytes written in that language.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Rule Suites

ID: get_list_repository_rule_suites
Operation: read
Entities: repository, rule suite, user
Summary: The 'List Repository Rule Suites' API endpoint allows users to list suites of rule evaluations at the repository level. It requires a GET request to the specified URL with the repository owner and name as path parameters. The API supports various query parameters such as 'ref', 'time_period', 'actor_name', 'rule_suite_result', 'per_page', and 'page' to filter the results. The response includes an array of rule suite objects, each containing details like 'id', 'actor_id', 'actor_name', 'before_sha', 'after_sha', 'ref', 'repository_id', 'repository_name', 'pushed_at', 'result', and 'evaluation_result'. The API requires an authorization header with a bearer token and optionally accepts a custom 'accept' header for specifying the response format.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Tags

ID: get_list_repository_tags
Operation: read
Entities: tag, repository, commit
Summary: The 'List Repository Tags' API endpoint retrieves a list of tags for a specified GitHub repository. It requires the 'owner' and 'repo' path parameters to specify the repository. Optional query parameters 'per_page' and 'page' can be used for pagination. The API can be accessed with or without authentication, but fine-grained access tokens with 'Metadata' repository permissions are recommended for private resources. The response includes an array of tag objects, each containing details such as the tag name, commit SHA, and URLs for zipball and tarball downloads.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Teams

ID: get_list_repository_teams
Operation: read
Entities: team, repository, token
Summary: The 'List Repository Teams' API endpoint allows users to list the teams that have access to a specified repository and are visible to the authenticated user. For public repositories, a team is listed only if it explicitly added the public repository. The endpoint requires OAuth app tokens or personal access tokens with the 'public_repo' or 'repo' scope for public repositories, and 'repo' scope for private repositories. Fine-grained access tokens with 'Administration' repository permissions (read) are also supported. The API accepts headers for content type and authorization, path parameters for the repository owner and name, and optional query parameters for pagination. The response includes an array of team objects, each containing details such as team ID, name, description, privacy level, and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Webhooks

ID: get_list_repository_webhooks
Operation: read
Entities: repository, token, webhook
Summary: The 'List Repository Webhooks' API endpoint allows users to list all webhooks for a specified repository on GitHub. It requires the 'owner' and 'repo' path parameters to specify the repository. The API supports pagination through 'per_page' and 'page' query parameters. The response includes an array of webhook objects, each containing details such as the webhook type, ID, name, active status, events, configuration, and URLs for testing, pinging, and deliveries. The API requires authentication via a Bearer token and recommends setting the 'accept' header to 'application/vnd.github+json'.
Input Fields: Input Fields
Output Fields: Output Fields

List SCIM Provisioned Identities

ID: get_list_scim_provisioned_identities
Operation:
Entities:
Summary: The 'List SCIM Provisioned Identities' API retrieves a paginated list of all provisioned organization members, including pending invitations. It supports filtering by user attributes such as id, userName, emails, and externalId. The API requires an organization name as a path parameter and supports pagination through query parameters 'startIndex' and 'count'. The response includes a list of SCIM provisioned identities with details such as userName, displayName, emails, and active status. The API requires authentication via a Bearer token with 'Members' organization permissions (read).
Input Fields: Input Fields
Output Fields: Output Fields

List Security Manager Teams

ID: get_list_security_manager_teams
Operation: read
Entities: team, security manager, organization
Summary: The 'List Security Manager Teams' API endpoint retrieves a list of security manager teams for a specified organization. It requires an organization name as a path parameter and uses fine-grained access tokens with 'Administration' organization permissions set to read. The response includes details about each team, such as its ID, name, description, privacy level, and permissions. This endpoint is scheduled to be deprecated on January 1, 2026, and users are advised to use the 'Organization Roles' endpoints instead.
Input Fields: Input Fields
Output Fields: Output Fields

List social accounts for a user

ID: get_list_social_accounts_for_a_user
Operation: read
Entities: provider, social account, user
Summary: The 'List social accounts for a user' API endpoint allows users to retrieve a list of social media accounts associated with a specified GitHub user. This endpoint is accessible by anyone and can be used without authentication if only public resources are requested. It supports fine-grained access tokens such as GitHub App user access tokens, GitHub App installation access tokens, and fine-grained personal access tokens, without requiring any specific permissions. The request requires a path parameter 'username' to specify the GitHub user account. Optional query parameters 'per_page' and 'page' can be used for pagination. The response is an array of social media accounts, each containing a 'provider' and a 'url'.
Input Fields: Input Fields
Output Fields: Output Fields

List Social Accounts for Authenticated User

ID: get_list_social_accounts_for_authenticated_user
Operation: read
Entities: provider, social account, user
Summary: The 'List Social Accounts for Authenticated User' API endpoint allows you to retrieve a list of all social accounts associated with the authenticated user. It requires a bearer token for authentication and supports optional query parameters for pagination, such as 'per_page' to specify the number of results per page and 'page' to specify the page number. The response is an array of social account objects, each containing a 'provider' and a 'url'. The endpoint returns various HTTP status codes, including 200 for success, 304 for not modified, 401 for authentication required, 403 for forbidden access, and 404 for resource not found.
Input Fields: Input Fields
Output Fields: Output Fields

List Sub-Issues on a GitHub Issue

ID: get_list_sub_issues
Operation: read
Entities: sub-issue, repository, issue
Summary: The 'List Sub-Issues on a GitHub Issue' API allows users to retrieve a list of sub-issues associated with a specific issue in a GitHub repository. The API requires the owner, repository name, and issue number as path parameters. It supports optional query parameters for pagination, such as 'per_page' and 'page'. The API can be accessed with or without authentication, but authentication is required for accessing private resources. The response includes detailed information about each sub-issue, such as its ID, URL, state, title, body, user details, labels, assignees, milestone, and more. The API supports various media types for the response format, including raw, text, HTML, and full representations of the markdown body.
Input Fields: Input Fields
Output Fields: Output Fields

Closing down - List tag protection states for a repository

ID: get_list_tag_protection_states_for_repository
Operation: read
Entities: tag protection state, repository, token
Summary: This API endpoint returns the tag protection states of a specified repository. It is accessible only to repository administrators and requires a fine-grained access token with 'Administration' repository permissions set to read. The endpoint is closing down and will be removed after August 30, 2024. It is recommended to use the 'Repository Rulesets' endpoint instead. The request requires the 'owner' and 'repo' path parameters, and the 'Authorization' header with a bearer token. The response includes an array of tag protection objects, each containing details such as 'id', 'pattern', 'created_at', 'updated_at', and 'enabled'.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Discussions

ID: get_list_team_discussions
Operation: read
Entities: discussion, team, organization
Summary: The 'List Team Discussions' API endpoint allows users to retrieve all discussions on a specified team's page within an organization. The endpoint requires the organization name and team slug as path parameters. Optional query parameters include direction for sorting, number of results per page, page number, and a filter for pinned discussions. The response includes an array of discussions, each containing details such as author information, discussion body, comments count, creation date, and reactions. OAuth app tokens and personal access tokens with the 'read:discussion' scope are required for authentication.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Members

ID: get_list_team_members
Operation: read
Entities: team, member, organization
Summary: The 'List Team Members' API endpoint allows users to retrieve a list of members in a specified team within an organization on GitHub. The team members include those from child teams. The API requires the team to be visible to the authenticated user. The request must include the organization name and team slug as path parameters. Optional query parameters allow filtering by role, and pagination options are available. The response returns an array of user objects, each containing details such as login, id, avatar URL, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Members (Legacy)

ID: get_list_team_members_legacy
Operation: read
Entities: role, team, member
Summary: The 'List Team Members (Legacy)' API endpoint retrieves a list of members for a specified team, including members of child teams. This endpoint is being deprecated, and users are advised to migrate to the new endpoint. The request requires a team_id as a path parameter and supports optional query parameters such as role, per_page, and page for filtering and pagination. The response returns an array of user objects, each containing details like login, id, avatar_url, and more. The endpoint requires authentication via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Projects

ID: get_list_team_projects
Operation: read
Entities: team, project, organization
Summary: The 'List Team Projects' API endpoint allows users to list the organization projects for a specific team within an organization on GitHub. The API requires the organization name and the team slug as path parameters. It supports optional query parameters for pagination, including 'per_page' to specify the number of results per page and 'page' to specify the page number. The response includes an array of projects with details such as project URLs, IDs, names, states, and creator information. The API returns a 200 OK status code upon success.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Projects (Legacy)

ID: get_list_team_projects_legacy
Operation: read
Entities: team, project, organization
Summary: The 'List Team Projects (Legacy)' API endpoint retrieves a list of organization projects associated with a specific team. This endpoint is part of the GitHub Teams API and is scheduled for deprecation. Users are advised to migrate to the new endpoint. The API requires a team_id as a path parameter to identify the team. Optional query parameters include per_page and page for pagination. The request headers should include an accept header set to application/vnd.github+json and an Authorization header with a bearer token. The response is an array of project objects, each containing details such as the project URL, name, state, creator information, and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Repositories

ID: get_list_team_repositories
Operation: read
Entities: team, repository, organization
Summary: The 'List Team Repositories' API endpoint allows users to list all repositories of a specified team within an organization that are visible to the authenticated user. The API requires the organization name and team slug as path parameters. Optional query parameters include 'per_page' to specify the number of results per page (default is 30, max is 100) and 'page' to specify the page number of results to fetch (default is 1). The response is an array of repository objects, each containing details such as repository ID, name, owner information, visibility, and permissions. The API requires authentication via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

List Team Repositories (Legacy)

ID: get_list_team_repositories_legacy
Operation: read
Entities: team, repository, user
Summary: The 'List Team Repositories (Legacy)' API endpoint retrieves a list of repositories associated with a specific team on GitHub. This endpoint is part of the legacy Teams API and is scheduled for deprecation. Users are encouraged to migrate to the new endpoint. The API requires a team_id as a path parameter to identify the team. Optional query parameters include per_page, which specifies the number of results per page (default is 30, maximum is 100), and page, which specifies the page number of results to fetch (default is 1). The response is an array of repository objects, each containing details such as the repository's id, name, owner, and various URLs related to the repository. The API returns a 200 status code for a successful request and a 404 status code if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

List Teams for Authenticated User

ID: get_list_teams_for_authenticated_user
Operation: read
Entities: team, user, organization
Summary: The 'List Teams for Authenticated User' API endpoint allows the authenticated user to retrieve a list of all teams across all organizations they belong to. The endpoint requires an OAuth app token or a personal access token with the user, repo, or read:org scope. Fine-grained personal access tokens are also supported, but the resource owner must be a single organization. The API accepts optional query parameters for pagination, such as 'per_page' and 'page'. The response includes detailed information about each team, including its ID, name, description, privacy settings, and associated organization details.
Input Fields: Input Fields
Output Fields: Output Fields

List Teams in an Organization

ID: get_list_teams_in_organization
Operation: read
Entities: permission, team, organization
Summary: The 'List Teams in an Organization' API endpoint allows users to retrieve a list of all teams within a specified organization that are visible to the authenticated user. The request requires an organization name as a path parameter and supports optional query parameters for pagination, such as 'per_page' and 'page'. The response includes an array of team objects, each containing details like team ID, name, description, privacy settings, and URLs for team members and repositories. Authentication is required via a bearer token with 'Members' organization permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

List the people a user follows

ID: get_list_the_people_a_user_follows
Operation: read
Entities: person, user, resource
Summary: The 'List the people a user follows' API endpoint allows you to retrieve a list of users that a specified GitHub user follows. It requires the 'username' path parameter to specify the GitHub user account. The API supports optional query parameters 'per_page' and 'page' for pagination, with defaults set to 30 and 1, respectively. The request headers can include 'accept' for specifying the response format, 'Authorization' for bearer token authentication, and 'X-GitHub-Api-Version' for API versioning. The response is an array of user objects, each containing details such as 'login', 'id', 'avatar_url', and more. This endpoint can be accessed without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

List the people the authenticated user follows

ID: get_list_the_people_the_authenticated_user_follows
Operation: read
Entities: follower, token, user
Summary: This API endpoint lists the people that the authenticated user follows on GitHub. It requires a fine-grained access token with 'Followers' user permissions set to read. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for specifying the API version. Query parameters 'per_page' and 'page' can be used for pagination. The response is an array of user objects, each containing details like login, id, avatar_url, and various URLs related to the user's GitHub profile.
Input Fields: Input Fields
Output Fields: Output Fields

List timeline events for an issue

ID: get_list_timeline_events_for_an_issue
Operation: read
Entities: repository, timeline event, issue
Summary: The 'List timeline events for an issue' API endpoint allows users to retrieve all timeline events associated with a specific issue in a GitHub repository. This endpoint requires the specification of the repository owner, repository name, and issue number as path parameters. Optional query parameters include 'per_page' to specify the number of results per page and 'page' to specify the page number of results to fetch. The API can be accessed with or without authentication, but fine-grained access tokens with specific permissions are required for private resources. The response includes an array of timeline events, each containing details such as the event ID, URL, actor information, event type, and creation time.
Input Fields: Input Fields
Output Fields: Output Fields

List Users Blocked by an Organization

ID: get_list_users_blocked_by_an_organization
Operation: read
Entities: permission, user, organization
Summary: The 'List Users Blocked by an Organization' API endpoint allows you to retrieve a list of users that have been blocked by a specified organization on GitHub. To access this endpoint, you need to provide a valid bearer token with the 'Blocking users' organization permissions set to read. The request requires the organization name as a path parameter. Optional query parameters include 'per_page' to specify the number of results per page (default is 30, maximum is 100) and 'page' to specify the page number of results to fetch (default is 1). The response is an array of user objects, each containing details such as login, id, avatar URL, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Users Blocked by Authenticated User

ID: get_list_users_blocked_by_authenticated_user
Operation: read
Entities: permission, token, user
Summary: This API endpoint allows the authenticated user to list all the users they have blocked on their personal GitHub account. It requires a fine-grained access token with 'Block another user' user permissions set to read. The request can include headers such as 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for the API version. Query parameters 'per_page' and 'page' can be used for pagination. The response is an array of user objects, each containing details like login, id, avatar_url, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Users on GitHub

ID: get_list_users_on_github
Operation: read
Entities: user, organization
Summary: The 'List Users on GitHub' API endpoint retrieves a list of all users on GitHub, including both personal and organization accounts, in the order they signed up. The endpoint supports pagination through the 'since' query parameter and returns a maximum of 100 users per page, with a default of 30. The response includes detailed information about each user, such as their login, ID, avatar URL, and various URLs related to their GitHub activity. The API can be accessed without authentication for public resources, but supports fine-grained access tokens for authenticated requests.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organization Membership for a User

ID: get_organization_membership_for_a_user
Operation: read
Entities: organization, user, membership
Summary: This API endpoint retrieves the membership details of a user within a specified GitHub organization. The authenticated user must be a member of the organization to access this information. The request requires the organization name and the GitHub username as path parameters. The response includes details such as the membership state, role, and organization information. The API supports fine-grained access tokens with 'Members' organization permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organization Membership for Authenticated User

ID: get_organization_membership_for_authenticated_user
Operation: read
Entities: organization, user, membership
Summary: This API endpoint retrieves the organization membership details for the authenticated user. If the user is an active or pending member of the specified organization, their membership details are returned. If the user is not affiliated with the organization, a 404 error is returned. A 403 error is returned if the request is made by a GitHub App blocked by the organization. The request requires a bearer token with 'Members' organization permissions set to 'read'. The endpoint accepts an optional 'accept' header for specifying the response format and requires the organization name as a path parameter.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Organization Repository Ruleset

ID: get_organization_repository_ruleset
Operation: read
Entities: ruleset, repository, organization
Summary: The 'Get an Organization Repository Ruleset' API retrieves a specific repository ruleset for a given organization. It requires the organization name and the ruleset ID as path parameters. The API request must include an authorization header with a bearer token. The response includes details about the ruleset such as its ID, name, target, source type, enforcement level, bypass actors, conditions, rules, and links to the ruleset. The bypass_actors property is only returned if the user has write access to the ruleset. The API supports fine-grained access tokens with 'Administration' organization permissions set to write.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Organization Role

ID: get_organization_role
Operation: read
Entities: role, permission, organization
Summary: The 'Get an Organization Role' API endpoint retrieves a specific organization role available to a given organization. To access this endpoint, the authenticated user must have appropriate permissions, such as being an administrator for the organization or having specific read permissions. The endpoint requires the organization name and role ID as path parameters. The response includes details about the role, such as its ID, name, description, permissions, and associated organization information. The API supports fine-grained access tokens with specific permissions for accessing custom organization roles.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Organization Rule Suite

ID: get_organization_rule_suite
Operation: read
Entities: rule evaluation, rule suite, organization
Summary: The 'Get an Organization Rule Suite' API endpoint retrieves information about a suite of rule evaluations within a specified organization. It requires the organization name and the unique identifier of the rule suite as path parameters. The request headers should include an authorization token and can optionally specify the API version and accept header. The response includes details about the rule suite, such as the actor involved, commit SHAs, repository information, and the results of individual rule evaluations. The API supports fine-grained access tokens with 'Administration' organization permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Organization Webhook

ID: get_organization_webhook
Operation: read
Entities: webhook, token, organization
Summary: This API endpoint retrieves a webhook configured in an organization. It requires the user to be an organization owner and the use of OAuth app tokens or personal access tokens with the admin:org_hook scope. The endpoint returns details about the webhook, including its ID, URL, events it listens to, and configuration details. The response includes the webhook's creation and update timestamps, and its active status.
Input Fields: Input Fields
Output Fields: Output Fields

List Pending Organization Invitations

ID: get_pending_organization_invitations
Operation: read
Entities: role, organization, invitation
Summary: The 'List Pending Organization Invitations' API endpoint allows users to retrieve a list of pending invitations for a specified GitHub organization. The endpoint requires the organization name as a path parameter and supports optional query parameters for pagination and filtering by role and invitation source. The response includes details about each invitation, such as the invitee's login, email, role, and the inviter's information. The API requires a bearer token for authentication and supports fine-grained access tokens with 'Members' organization permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

Check if Private Vulnerability Reporting is Enabled for a Repository

ID: get_private_vulnerability_reporting_status
Operation: read
Entities: vulnerability reporting, repository, access token
Summary: This API checks if private vulnerability reporting is enabled for a specified repository. It returns a boolean value indicating the status. The request requires the 'owner' and 'repo' path parameters to specify the repository. Optional headers include 'accept' for specifying the response format, 'Authorization' for authentication, and 'X-GitHub-Api-Version' for specifying the API version. The response includes a boolean 'enabled' field indicating the status of private vulnerability reporting. The API can be accessed without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

Get a public SSH key for the authenticated user

ID: get_public_ssh_key_for_authenticated_user
Operation: read
Entities: GitHub App, SSH key, user
Summary: This API endpoint retrieves a public SSH key for the authenticated user. It requires an OAuth app token or personal access token with the 'read:public_key' scope. The endpoint accepts a 'key_id' as a path parameter to specify which key to retrieve. The response includes details about the SSH key such as the key string, its ID, URL, title, creation date, verification status, and whether it is read-only. The API returns various HTTP status codes including 200 for success, 304 if not modified, 401 for authentication issues, 403 for forbidden access, and 404 if the resource is not found.
Input Fields: Input Fields
Output Fields: Output Fields

List Repositories Accessible by Fine-Grained Personal Access Token

ID: get_repositories_accessible_by_fine_grained_token
Operation: read
Entities: GitHub App, fine-grained personal access token, repository
Summary: This API endpoint lists the repositories that a fine-grained personal access token has access to within a specified organization. It is accessible only by GitHub Apps using either user access tokens or installation access tokens. The token must have 'Personal access tokens' organization permissions set to 'read'. The request requires the organization name and the unique identifier of the personal access token as path parameters. Optional query parameters include 'per_page' to specify the number of results per page and 'page' to specify the page number of results. The response returns a list of repositories with detailed information about each repository, including its ID, name, owner, visibility, and permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List Repositories Requested by Fine-Grained Personal Access Token

ID: get_repositories_requested_by_fine_grained_token
Operation: read
Entities: personal access token, organization, repository
Summary: This API endpoint lists the repositories that a fine-grained personal access token request is requesting access to within a specified organization. It is accessible only by GitHub Apps using either user access tokens or installation access tokens. The request requires the organization name and the unique identifier of the personal access token request as path parameters. Optional query parameters include 'per_page' to specify the number of results per page and 'page' to specify the page number of results. The response includes detailed information about each repository, such as its ID, name, owner details, visibility, and permissions. The API requires the 'Personal access token requests' organization permissions set to 'read'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Repository Content

ID: get_repository_content
Operation: read
Entities: file, directory, repository
Summary: The 'Get Repository Content' API retrieves the contents of a file or directory in a GitHub repository. The path parameter specifies the file or directory path. If omitted, the root directory contents are returned. The API supports custom media types for raw, HTML, and object formats. It handles directories, symlinks, and submodules with specific behaviors. The API requires 'Contents' repository permissions for private resources but can be used without authentication for public resources. It supports fine-grained access tokens. The response includes file metadata and content, with limitations based on file size.
Input Fields: Input Fields
Output Fields: Output Fields

List Repository Invitations for Authenticated User

ID: get_repository_invitations_for_authenticated_user
Operation: read
Entities: repository invitation, repository, user
Summary: This API endpoint lists all currently open repository invitations for the authenticated user. It requires authentication with a fine-grained access token having 'Administration' repository permissions (read) or can be used without authentication for public resources. The request can include headers such as 'accept' for specifying the response format and 'Authorization' for bearer token authentication. Query parameters 'per_page' and 'page' can be used for pagination. The response includes an array of repository invitations, each containing details about the repository, invitee, inviter, permissions, and URLs.
Input Fields: Input Fields
Output Fields: Output Fields

Get Repository Permissions for a User

ID: get_repository_permissions_for_a_user
Operation: read
Entities: permission, repository, collaborator
Summary: The 'Get Repository Permissions for a User' API checks the repository permission of a collaborator. It returns the permission level (admin, write, read, or none) and the role name, which includes custom roles. The API requires the 'owner', 'repo', and 'username' as path parameters and accepts an optional 'accept' header for specifying the response format. The response includes the permission level, role name, and user details such as login, id, and URLs. The API supports fine-grained access tokens with 'Metadata' repository permissions set to read.
Input Fields: Input Fields
Output Fields: Output Fields

Get a repository README

ID: get_repository_readme
Operation: read
Entities: file, owner, repository
Summary: The 'Get a repository README' API retrieves the preferred README file for a specified repository. It requires the 'owner' and 'repo' path parameters to identify the repository. The 'ref' query parameter can be used to specify a commit, branch, or tag, defaulting to the repository's default branch if not provided. The API supports custom media types, allowing the README to be returned as raw content or HTML. The response includes details such as the file type, encoding, size, name, path, content, and various URLs related to the README file. Authentication is required via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Get a repository README for a directory

ID: get_repository_readme_for_directory
Operation: read
Entities: repository, directory, readme
Summary: The 'Get a repository README for a directory' API retrieves the README file from a specified directory within a GitHub repository. It requires the 'owner', 'repo', and 'dir' path parameters to specify the repository and directory. The 'ref' query parameter can be used to specify a commit, branch, or tag, defaulting to the repository's default branch if not provided. The API supports custom media types to return the README in raw or HTML format. The response includes details about the README file, such as its type, encoding, size, name, path, content, and various URLs. The API returns a 200 status code for a successful request, 404 if the resource is not found, and 422 if validation fails or the endpoint is spammed.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Repository Rule Suite

ID: get_repository_rule_suite
Operation: read
Entities: rule evaluation, repository, rule suite
Summary: The 'Get a Repository Rule Suite' API endpoint retrieves information about a suite of rule evaluations within a repository. It requires a GET request to the specified URL with path parameters for the repository owner, repository name, and rule suite ID. The request headers should include an authorization token and can optionally specify the API version and accept header. The response includes details about the rule suite, such as the evaluation results, actor information, commit SHAs, and rule evaluations. The response body provides a comprehensive view of the rule suite's evaluation, including individual rule results and enforcement levels.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Repository Ruleset

ID: get_repository_ruleset
Operation: read
Entities: ruleset, repository, actor
Summary: The 'Get a Repository Ruleset' API endpoint retrieves a specific ruleset for a given repository. It requires the path parameters 'owner', 'repo', and 'ruleset_id' to identify the repository and ruleset. The API can optionally include rulesets from higher levels using the 'includes_parents' query parameter. The response includes details about the ruleset such as its ID, name, target, source, enforcement level, bypass actors, conditions, rules, and timestamps for creation and update. The 'bypass_actors' property is only returned if the user has write access to the ruleset. The API supports fine-grained access tokens and can be accessed without authentication for public resources.
Input Fields: Input Fields
Output Fields: Output Fields

Updated 9 days ago