GitHub Lists API
The Lists API from GitHub — 204 operation(s) for lists.
GitHub Lists API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include List. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.
This API exposes 163 operations across 163 paths, and defines 300 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.
Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.
163 operations
163 paths
300 schemas
163 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
GitHub Lists API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerHttpAuthentication).
bearerHttpAuthentication— Bearer Token
Paths & Operations 163
Across 163 paths, the API surfaces 163 operations — 163 GET. Each is listed below with its method, path, parameters, and response codes.
Lists 163
GET
/app/hook/deliveries
GitHub List Deliveries for an App Webhook
GET
/app/installation-requests
GitHub List Installation Requests for the Authenticated App
GET
/app/installations
GitHub List Installations for the Authenticated App
GET
/applications/grantsdeprecated
GitHub List Your Grants
GET
/authorizationsdeprecated
GitHub List Your Authorizations
GET
/gists/public
GitHub List Public Gists
GET
/gists/starred
GitHub List Starred Gists
GET
/gists/{gist_id}/comments
GitHub List Gist Comments
GET
/gists/{gist_id}/commits
GitHub List Gist Commits
GET
/gists/{gist_id}/forks
GitHub List Gist Forks
GET
/installation/repositories
GitHub List Repositories Accessible to the App Installation
GET
/orgs/{org}/installations
GitHub List App Installations for an Organization
GET
/user/installations
GitHub List App Installations Accessible to the User Access Token
GET
/user/installations/{installation_id}/repositories
GitHub List Repositories Accessible to the User Access Token
GET
/networks/{owner}/{repo}/events
GitHub List Public Events for Network of Repositories
GET
/organizations
GitHub List Organizations
GET
/organizations/{organization_id}/custom_rolesdeprecated
GitHub Deprecated - List Custom Repository Roles in an Organization
GET
/orgs/{org}/actions/cache/usage-by-repository
GitHub List Repositories with Github Actions Cache Usage for an Organization
GET
/orgs/{org}/actions/permissions/repositories
GitHub List Selected Repositories Enabled for Github Actions in an Organization
GET
/orgs/{org}/actions/runner-groups
GitHub List Self-hosted Runner Groups for an Organization
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub List Repository Access to Self-hosted Runner Group in an Organization
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub List Self-hosted Runners in Group for an Organization
GET
/orgs/{org}/actions/runners
GitHub List Self-hosted Runners for an Organization
GET
/orgs/{org}/actions/runners/downloads
GitHub List Runner Applications for an Organization
GET
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub List Labels for Self-hosted Runner for an Organization
GET
/orgs/{org}/actions/secrets
GitHub List Organization Secrets
GET
/orgs/{org}/actions/secrets/{secret_name}/repositories
GitHub List Selected Repositories for an Organization Secret
GET
/orgs/{org}/actions/variables
GitHub List Organization Variables
GET
/orgs/{org}/actions/variables/{name}/repositories
GitHub List Selected Repositories for an Organization Variable
GET
/orgs/{org}/code-scanning/alerts
GitHub List Code Scanning Alerts for an Organization
GET
/orgs/{org}/custom-repository-roles
GitHub List Custom Repository Roles in an Organization
GET
/orgs/{org}/dependabot/alerts
GitHub List Dependabot Alerts for an Organization
GET
/orgs/{org}/dependabot/secrets
GitHub List Organization Secrets
GET
/orgs/{org}/dependabot/secrets/{secret_name}/repositories
GitHub List Selected Repositories for an Organization Secret
GET
/orgs/{org}/docker/conflicts
GitHub Get List of Conflicting Packages During Docker Migration for Organization
GET
/orgs/{org}/events
GitHub List Public Organization Events
GET
/orgs/{org}/external-groups
GitHub List External Groups in an Organization
GET
/orgs/{org}/hooks
GitHub List Organization Webhooks
GET
/orgs/{org}/hooks/{hook_id}/deliveries
GitHub List Deliveries for an Organization Webhook
GET
/orgs/{org}/issues
GitHub List Organization Issues Assigned to the Authenticated User
GET
/orgs/{org}/members
GitHub List Organization Members
GET
/orgs/{org}/migrations
GitHub List Organization Migrations
GET
/orgs/{org}/migrations/{migration_id}/repositories
GitHub List Repositories in an Organization Migration
GET
/orgs/{org}/outside_collaborators
GitHub List Outside Collaborators for an Organization
GET
/orgs/{org}/packages
GitHub List Packages for an Organization
GET
/orgs/{org}/packages/{package_type}/{package_name}/versions
GitHub List Package Versions for Package Owned by an Organization
GET
/orgs/{org}/pre-receive-hooks
GitHub List Pre-receive Hooks for an Organization
GET
/orgs/{org}/projects
GitHub List Organization Projects
GET
/orgs/{org}/public_members
GitHub List Public Organization Members
GET
/orgs/{org}/repos
GitHub List Organization Repositories
GET
/orgs/{org}/repository-fine-grained-permissions
GitHub List Repository Fine-grained Permissions for an Organization
GET
/orgs/{org}/secret-scanning/alerts
GitHub List Secret Scanning Alerts for an Organization
GET
/orgs/{org}/security-managers
GitHub List Security Manager Teams
GET
/orgs/{org}/teams
GitHub List Teams
GET
/orgs/{org}/teams/{team_slug}/discussions
GitHub List Discussions
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
GitHub List Discussion Comments
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
GitHub List Reactions for Team Discussion Comment
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
GitHub List Reactions for Team Discussion
GET
/orgs/{org}/teams/{team_slug}/external-groups
GitHub List Connection Between an External Group and Team
GET
/orgs/{org}/teams/{team_slug}/members
GitHub List Team Members
GET
/orgs/{org}/teams/{team_slug}/projects
GitHub List Team Projects
GET
/orgs/{org}/teams/{team_slug}/repos
GitHub List Team Repositories
GET
/orgs/{org}/teams/{team_slug}/teams
GitHub List Child Teams
GET
/projects/columns/{column_id}/cards
GitHub List Project Cards
GET
/projects/{project_id}/collaborators
GitHub List Project Collaborators
GET
/projects/{project_id}/columns
GitHub List Project Columns
GET
/repos/{owner}/{repo}/projects
GitHub List Repository Projects
GET
/teams/{team_id}/projectsdeprecated
GitHub List Team Projects (legacy)
GET
/users/{username}/projects
GitHub List User Projects
GET
/repos/{owner}/{repo}/actions/artifacts
GitHub List Artifacts for Repository
GET
/repos/{owner}/{repo}/actions/caches
GitHub List Github Actions Caches for Repository
GET
/repos/{owner}/{repo}/actions/organization-secrets
GitHub List Repository Organization Secrets
GET
/repos/{owner}/{repo}/actions/organization-variables
GitHub List Repository Organization Variables
GET
/repos/{owner}/{repo}/actions/runners
GitHub List Self-hosted Runners for Repository
GET
/repos/{owner}/{repo}/actions/runners/downloads
GitHub List Runner Applications for Repository
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub List Labels for Self-hosted Runner for Repository
GET
/repos/{owner}/{repo}/actions/runs
GitHub List Workflow Runs for Repository
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
GitHub List Workflow Run Artifacts
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
GitHub List Jobs for Workflow Run Attempt
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
GitHub List Jobs for Workflow Run
GET
/repos/{owner}/{repo}/actions/secrets
GitHub List Repository Secrets
GET
/repos/{owner}/{repo}/actions/variables
GitHub List Repository Variables
GET
/repos/{owner}/{repo}/actions/workflows
GitHub List Repository Workflows
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
GitHub List Workflow Runs for Workflow
GET
/repos/{owner}/{repo}/code-scanning/alerts
GitHub List Code Scanning Alerts for Repository
GET
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
GitHub List Instances of Code Scanning Alert
GET
/repos/{owner}/{repo}/code-scanning/analyses
GitHub List Code Scanning Analyses for Repository
GET
/repos/{owner}/{repo}/collaborators
GitHub List Repository Collaborators
GET
/repos/{owner}/{repo}/dependabot/alerts
GitHub List Dependabot Alerts for Repository
GET
/repos/{owner}/{repo}/dependabot/secrets
GitHub List Repository Secrets
GET
/repos/{owner}/{repo}/hooks
GitHub List Repository Webhooks
GET
/repos/{owner}/{repo}/hooks/{hook_id}/deliveries
GitHub List Deliveries for Repository Webhook
GET
/repos/{owner}/{repo}/pre-receive-hooks
GitHub List Pre-receive Hooks for Repository
GET
/repos/{owner}/{repo}/invitations
GitHub List Repository Invitations
GET
/repos/{owner}/{repo}/issues
GitHub List Repository Issues
GET
/repos/{owner}/{repo}/issues/comments
GitHub List Issue Comments for Repository
GET
/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions
GitHub List Reactions for an Issue Comment
GET
/repos/{owner}/{repo}/issues/events
GitHub List Issue Events for Repository
GET
/repos/{owner}/{repo}/issues/{issue_number}/comments
GitHub List Issue Comments
GET
/repos/{owner}/{repo}/issues/{issue_number}/events
GitHub List Issue Events
GET
/repos/{owner}/{repo}/issues/{issue_number}/labels
GitHub List Labels for an Issue
GET
/repos/{owner}/{repo}/issues/{issue_number}/reactions
GitHub List Reactions for an Issue
GET
/repos/{owner}/{repo}/issues/{issue_number}/timeline
GitHub List Timeline Events for an Issue
GET
/repos/{owner}/{repo}/pulls
GitHub List Pull Requests
GET
/repos/{owner}/{repo}/pulls/comments
GitHub List Review Comments in Repository
GET
/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
GitHub List Reactions for Pull Request Review Comment
GET
/repos/{owner}/{repo}/pulls/{pull_number}/comments
GitHub List Review Comments on Pull Request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/commits
GitHub List Commits on Pull Request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/files
GitHub List Pull Requests Files
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews
GitHub List Reviews for Pull Request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
GitHub List Comments for Pull Request Review
GET
/repos/{owner}/{repo}/assignees
GitHub List Assignees
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
GitHub List Check Run Annotations
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
GitHub List Check Runs in Check Suite
GET
/repos/{owner}/{repo}/codeowners/errors
GitHub List Codeowners Errors
GET
/repos/{owner}/{repo}/comments
GitHub List Commit Comments for Repository
GET
/repos/{owner}/{repo}/comments/{comment_id}/reactions
GitHub List Reactions for Commit Comment
GET
/repos/{owner}/{repo}/commits
GitHub List Commits
GET
/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head
GitHub List Branches for Head Commit
GET
/repos/{owner}/{repo}/commits/{commit_sha}/comments
GitHub List Commit Comments
GET
/repos/{owner}/{repo}/commits/{commit_sha}/pulls
GitHub List Pull Requests Associated with Commit
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
GitHub List Check Runs for Git Reference
GET
/repos/{owner}/{repo}/commits/{ref}/check-suites
GitHub List Check Suites for Git Reference
GET
/repos/{owner}/{repo}/commits/{ref}/statuses
GitHub List Commit Statuses for Reference
GET
/repos/{owner}/{repo}/contributors
GitHub List Repository Contributors
GET
/repos/{owner}/{repo}/deployments
GitHub List Deployments
GET
/repos/{owner}/{repo}/deployments/{deployment_id}/statuses
GitHub List Deployment Statuses
GET
/repos/{owner}/{repo}/environments
GitHub List Environments
GET
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
GitHub List Deployment Branch Policies
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets
GitHub List Environment Secrets
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables
GitHub List Environment Variables
GET
/repos/{owner}/{repo}/events
GitHub List Repository Events
GET
/repos/{owner}/{repo}/forks
GitHub List Forks
GET
/repos/{owner}/{repo}/git/matching-refs/{ref}
GitHub List Matching References
GET
/repos/{owner}/{repo}/keys
GitHub List Deploy Keys
GET
/repos/{owner}/{repo}/labels
GitHub List Labels for Repository
GET
/repos/{owner}/{repo}/languages
GitHub List Repository Languages
GET
/repos/{owner}/{repo}/milestones
GitHub List Milestones
GET
/repos/{owner}/{repo}/milestones/{milestone_number}/labels
GitHub List Labels for Issues in Milestone
GET
/repos/{owner}/{repo}/notifications
GitHub List Repository Notifications for the Authenticated User
GET
/repos/{owner}/{repo}/pages/builds
GitHub List Github Enterprise Server Pages Builds
GET
/repos/{owner}/{repo}/releases
GitHub List Releases
GET
/repos/{owner}/{repo}/releases/{release_id}/assets
GitHub List Release Assets
GET
/repos/{owner}/{repo}/releases/{release_id}/reactions
GitHub List Reactions for Release
GET
/repos/{owner}/{repo}/replicas/caches
GitHub List Repository Cache Replication Status
GET
/repos/{owner}/{repo}/secret-scanning/alerts
GitHub List Secret Scanning Alerts for Repository
GET
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
GitHub List Locations for Secret Scanning Alert
GET
/repos/{owner}/{repo}/stargazers
GitHub List Stargazers
GET
/repos/{owner}/{repo}/subscribers
GitHub List Watchers
GET
/repos/{owner}/{repo}/tags
GitHub List Repository Tags
GET
/repos/{owner}/{repo}/tags/protection
GitHub List Tag Protection States for Repository
GET
/repos/{owner}/{repo}/teams
GitHub List Repository Teams
GET
/repositories
GitHub List Public Repositories
GET
/scim/v2/Groups
GitHub List Provisioned Scim Groups for an Enterprise
GET
/scim/v2/Users
GitHub List Scim Provisioned Identities for an Enterprise
GET
/teams/{team_id}/discussionsdeprecated
GitHub List Discussions (legacy)
GET
/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated
GitHub List Discussion Comments (legacy)
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsdeprecated
GitHub List Reactions for Team Discussion Comment (legacy)
GET
/teams/{team_id}/discussions/{discussion_number}/reactionsdeprecated
GitHub List Reactions for Team Discussion (legacy)
GET
/teams/{team_id}/membersdeprecated
GitHub List Team Members (legacy)
GET
/teams/{team_id}/reposdeprecated
GitHub List Team Repositories (legacy)
GET
/teams/{team_id}/teamsdeprecated
GitHub List Child Teams (legacy)
GET
/user/teams
GitHub List Teams for the Authenticated User
Schemas 300
The contract defines 300 schemas that model the data the API accepts and returns. The most detailed are repository_2 (95 properties), repository_3 (95 properties), repository_4 (95 properties), repository (95 properties). Each schema is shown below with its type and property counts.
installation
object
Installation
20 properties
17 required
scim-error
object
Scim Error
6 properties
simple-user
object
A GitHub user.
21 properties
18 required
validation-error
object
Validation Error
3 properties
2 required
basic-error
object
Basic Error
4 properties
integration-installation-request
object
Request to install an integration on a target
5 properties
4 required
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
11 properties
11 required
application-grant
object
The authorization associated with an OAuth Access.
7 properties
6 required
enterprise
object
An enterprise on GitHub.
10 properties
8 required
app-permissions
object
The permissions granted to the user access token.
45 properties
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
nullable-scoped-installation
objectnull
7 properties
5 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties
13 required
gist-comment
object
A comment made to a gist.
8 properties
8 required
gist-commit
object
Gist Commit
5 properties
5 required
gist-history
object
Gist History
5 properties
base-gist
object
Base Gist
20 properties
16 required
gist-simple
object
Gist Simple
21 properties
author-association
string
How the author is associated with the repository.
public-user
object
Public User
39 properties
31 required
repository
object
A repository on GitHub.
95 properties
73 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
nullable-integration
objectnull
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
actor
object
Actor
6 properties
5 required
reaction-rollup
object
10 properties
10 required
event
object
Event
8 properties
7 required
nullable-milestone
objectnull
A collection of related issues and pull requests.
16 properties
16 required
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-instance
object
10 properties
code-scanning-analysis-tool-guid
stringnull
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
dependabot-alert-package
object
Details for the vulnerable package.
2 properties
2 required
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
package
object
A software package
11 properties
9 required
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
runner
object
A self hosted runner
7 properties
6 required
alert-dismissed-at
stringnull
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
runner-label
object
A label for a self hosted runner
3 properties
1 required
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties
13 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
org-pre-receive-hook
object
5 properties
team-discussion-comment
object
A reply to a discussion within a team.
13 properties
12 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
code-scanning-alert-classification
stringnull
A classification of the file. For example to identify it as generated.
org-hook
object
Org Hook
11 properties
10 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties
3 required
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
secret-scanning-alert-resolution
stringnull
Required when the state is resolved. The reason for resolving the alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
runner-groups-org
object
12 properties
7 required
code-scanning-alert-state-query
string
State of a code scanning alert.
package-version
object
A version of a software package
11 properties
6 required
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties
5 required
simple-repository
object
A GitHub repository.
46 properties
46 required
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties
17 required
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
code-scanning-organization-alert-items
object
16 properties
13 required
code-scanning-analysis-tool-version
stringnull
The version of the tool used to generate the code scanning analysis.
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
stringnull
The dismissal comment associated with the dismissal of the alert.
alert-url
string
The REST API URL of the alert resource.
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties
5 required
organization-dependabot-secret
object
Secrets for GitHub Dependabot for an organization.
5 properties
4 required
code-scanning-alert-state
string
State of a code scanning alert.
code-of-conduct
object
Code Of Conduct
5 properties
4 required
minimal-repository
object
Minimal Repository
87 properties
46 required
code-scanning-alert-severity
string
Severity of a code scanning alert.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
security-and-analysis
objectnull
3 properties
organization-simple
object
A GitHub organization.
12 properties
12 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
nullable-alert-updated-at
stringnull
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-alert-with-repository
object
A Dependabot alert.
16 properties
15 required
repository-fine-grained-permission
object
A fine-grained permission that protects repository resources.
2 properties
2 required
external-groups
object
A list of external groups available to be connected to a team
1 property
team-project
object
A team's access to a project.
16 properties
14 required
runner-application
object
Runner Application
6 properties
4 required
code-scanning-alert-dismissed-reason
stringnull
Required when the state is dismissed. The reason for dismissing or closing the alert.
validation-error-simple
object
Validation Error Simple
3 properties
2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties
4 required
alert-html-url
string
The GitHub URL of the alert resource.
nullable-minimal-repository
objectnull
Minimal Repository
87 properties
46 required
code-scanning-alert-rule-summary
object
6 properties
organization-secret-scanning-alert
object
18 properties
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
alert-auto-dismissed-at
stringnull
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-number
integer
The security alert number.
alert-fixed-at
stringnull
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
migration
object
A migration.
18 properties
16 required
project-card
object
Project cards represent a scope of work.
13 properties
9 required
project-column
object
Project columns contain cards of work.
8 properties
8 required
code-of-conduct_2
object
Code Of Conduct
5 properties
4 required
minimal-repository_2
object
Minimal Repository
87 properties
46 required
workflow-run
object
An invocation of a workflow
36 properties
26 required
security-and-analysis_2
object
3 properties
simple-user_2
object
GitHub user.
21 properties
18 required
actions-secret
object
Set secrets for GitHub Actions.
3 properties
3 required
runner_2
object
self hosted runner
7 properties
6 required
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties
2 required
runner-label_2
object
label for a self hosted runner
3 properties
1 required
pull-request-minimal
object
5 properties
5 required
actions-cache-list
object
Repository actions caches
2 properties
2 required
workflow
object
GitHub Actions workflow
11 properties
10 required
actions-variable
object
4 properties
4 required
job
object
Information of a job execution in a workflow run
23 properties
21 required
artifact
object
An artifact
11 properties
10 required
runner-application_2
object
Runner Application
6 properties
4 required
nullable-simple-commit
object
commit.
6 properties
6 required
code-scanning-alert-items
object
15 properties
12 required
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
code-scanning-analysis-tool-guid_2
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-alert-rule-summary_2
object
6 properties
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
code-scanning-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-fixed-at_2
string
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-tool-version_2
string
The version of the tool used to generate the code scanning analysis.
alert-dismissed-at_2
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-sarif-id
string
An identifier for the upload.
nullable-simple-user_2
object
GitHub user.
21 properties
18 required
code-scanning-analysis
object
15 properties
14 required
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-alert-dismissed-comment_2
string
The dismissal comment associated with the dismissal of the alert.
code-scanning-alert-dismissed-reason_2
string
Required when the state is dismissed. The reason for dismissing or closing the alert.
code-scanning-alert-classification_2
string
classification of the file. For example to identify it as generated.
collaborator
object
Collaborator
22 properties
18 required
scim-error_2
object
Scim Error
6 properties
alert-auto-dismissed-at_2
string
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-secret
object
Set secrets for Dependabot.
3 properties
3 required
dependabot-alert-security-vulnerability_2
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
alert-fixed-at_3
string
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-dismissed-at_3
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-alert-security-advisory_2
object
Details for the GitHub Security Advisory.
13 properties
13 required
dependabot-alert
object
Dependabot alert.
15 properties
14 required
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
repository-pre-receive-hook
object
4 properties
scim-error_3
object
Scim Error
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
hook-response
object
3 properties
3 required
validation-error_2
object
Validation Error
3 properties
2 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
hook
object
Webhooks for repositories.
13 properties
12 required
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config-insecure-ssl
hook-delivery-item_2
object
Delivery made by a webhook, without request and response information.
12 properties
11 required
webhook-config
object
Configuration object of the webhook
4 properties
simple-user_3
object
GitHub user.
21 properties
18 required
code-of-conduct_3
object
Code Of Conduct
5 properties
4 required
minimal-repository_3
object
Minimal Repository
87 properties
46 required
nullable-simple-user_4
object
GitHub user.
21 properties
18 required
repository-invitation
object
Repository invitations let you manage who you collaborate with.
10 properties
9 required
security-and-analysis_3
object
3 properties
timeline-issue-events
object
Timeline Event
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
converted-note-to-issue-issue-event
object
Converted Note to Issue Issue Event
10 properties
9 required
unlabeled-issue-event
object
Unlabeled Issue Event
10 properties
10 required
locked-issue-event
object
Locked Issue Event
10 properties
10 required
demilestoned-issue-event
object
Demilestoned Issue Event
10 properties
10 required
issue-event-rename
object
Issue Event Rename
2 properties
2 required
nullable-issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
simple-user_4
object
GitHub user.
21 properties
18 required
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
issue-event-milestone
object
Issue Event Milestone
1 property
1 required
nullable-integration_2
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
issue-event-label
object
Issue Event Label
2 properties
2 required
repository_2
object
repository on GitHub.
95 properties
73 required
removed-from-project-issue-event
object
Removed from Project Issue Event
10 properties
9 required
review-requested-issue-event
object
Review Requested Issue Event
12 properties
10 required
validation-error_3
object
Validation Error
3 properties
2 required
issue-event-for-issue
Issue Event for Issue
timeline-commit-commented-event
object
Timeline Commit Commented Event
4 properties
labeled-issue-event
object
Labeled Issue Event
10 properties
10 required
nullable-license-simple_2
object
License Simple
6 properties
5 required
renamed-issue-event
object
Renamed Issue Event
10 properties
10 required
review-dismissed-issue-event
object
Review Dismissed Issue Event
10 properties
10 required
integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
timeline-reviewed-event
object
Timeline Reviewed Event
14 properties
11 required
timeline-comment-event
object
Timeline Comment Event
16 properties
11 required
commit-comment
object
Commit Comment
14 properties
13 required
timeline-assigned-issue-event
object
Timeline Assigned Issue Event
10 properties
10 required
timeline-committed-event
object
Timeline Committed Event
11 properties
10 required
unassigned-issue-event
object
Unassigned Issue Event
11 properties
11 required
issue_2
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
timeline-line-commented-event
object
Timeline Line Commented Event
3 properties
assigned-issue-event
object
Assigned Issue Event
11 properties
11 required
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
issue-event-project-card
object
Issue Event Project Card
6 properties
5 required
added-to-project-issue-event
object
Added to Project Issue Event
10 properties
9 required
timeline-unassigned-issue-event
object
Timeline Unassigned Issue Event
10 properties
10 required
moved-column-in-project-issue-event
object
Moved Column in Project Issue Event
10 properties
9 required
state-change-issue-event
object
State Change Issue Event
10 properties
9 required
review-request-removed-issue-event
object
Review Request Removed Issue Event
12 properties
10 required
issue-event
object
Issue Event
22 properties
8 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
milestoned-issue-event
object
Milestoned Issue Event
10 properties
10 required
timeline-cross-referenced-event
object
Timeline Cross Referenced Event
5 properties
4 required
nullable-simple-user_5
object
GitHub user.
21 properties
18 required
nullable-milestone_2
object
collection of related issues and pull requests.
16 properties
16 required
issue-event-dismissed-review
object
4 properties
3 required
nullable-simple-user_6
object
GitHub user.
21 properties
18 required
project_2
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
link
object
Hypermedia Link
1 property
1 required
team_3
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
diff-entry
object
Diff Entry
11 properties
9 required
commit
object
Commit
11 properties
9 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
simple-user_5
object
GitHub user.
21 properties
18 required
repository_3
object
repository on GitHub.
95 properties
73 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties
10 required
validation-error_4
object
Validation Error
3 properties
2 required
verification
object
4 properties
4 required
pull-request-simple
object
Pull Request Simple
36 properties
31 required
nullable-team-simple_3
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
empty-object
object
An object without any properties.
review-comment
object
Legacy Review Comment
28 properties
18 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 required
pull-request-review-comment_2
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
nullable-simple-user_7
object
GitHub user.
21 properties
18 required
nullable-milestone_3
object
collection of related issues and pull requests.
16 properties
16 required
nullable-license-simple_3
object
License Simple
6 properties
5 required
thread
object
Thread
9 properties
9 required
language
object
Language
tag-protection
object
Tag protection
5 properties
1 required
check-suite
object
suite of checks performed on the code of a given code change
19 properties
17 required
wait-timer
integer
The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
status
object
The status of a commit.
11 properties
11 required
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties
10 required
simple-commit
object
commit.
6 properties
6 required
secret-scanning-location-discussion-comment
object
Represents a 'discussioncomment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
1 property
1 required
secret-scanning-location-pull-request-review-comment
object
Represents a 'pullrequestreviewcomment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull reques…
1 property
1 required
release
object
release.
22 properties
17 required
tag
object
Tag
5 properties
5 required
check-run
object
check performed on the code of a given code change
17 properties
16 required
nullable-simple-user_8
object
GitHub user.
21 properties
18 required
secret-scanning-alert-resolution_2
string
Required when the state is resolved. The reason for resolving the alert.
secret-scanning-location
object
2 properties
2 required
team_4
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
secret-scanning-location-discussion-body
object
Represents a 'discussionbody' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
1 property
1 required
secret-scanning-location-issue-body
object
Represents an 'issuebody' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
1 property
1 required
scim-error_4
object
Scim Error
6 properties
commit_2
object
Commit
11 properties
9 required
deployment-reviewer-type
string
The type of reviewer.
validation-error_5
object
Validation Error
3 properties
2 required
secret-scanning-location-pull-request-body
object
Represents a 'pullrequestbody' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
1 property
1 required
secret-scanning-location-commit
object
Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
9 properties
9 required
release-asset
object
Data related to a release.
13 properties
13 required
secret-scanning-location-issue-title
object
Represents an 'issuetitle' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
1 property
1 required
page-build
object
Page Build
8 properties
8 required
nullable-team-simple_4
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
event_2
object
Event
8 properties
7 required
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
nullable-license-simple_4
object
License Simple
6 properties
5 required
check-annotation
object
Check Annotation
10 properties
10 required
code-of-conduct_4
object
Code Of Conduct
5 properties
4 required
minimal-repository_4
object
Minimal Repository
87 properties
46 required
security-and-analysis_4
object
3 properties
codeowners-errors
object
list of errors found in a repo's CODEOWNERS file
1 property
1 required
branch-short
object
Branch Short
3 properties
3 required
milestone
object
collection of related issues and pull requests.
16 properties
16 required
nullable-alert-updated-at_2
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
secret-scanning-location-discussion-title
object
Represents a 'discussiontitle' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
1 property
1 required
stargazer
object
Stargazer
2 properties
2 required
actor_2
object
Actor
6 properties
5 required
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties
14 required
environment
object
Details of a deployment environment
9 properties
7 required
nullable-milestone_4
object
collection of related issues and pull requests.
16 properties
16 required
git-ref
object
Git references within a repository
4 properties
4 required
simple-user_6
object
GitHub user.
21 properties
18 required
nullable-integration_3
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
repository_4
object
repository on GitHub.
95 properties
73 required
secret-scanning-location-issue-comment
object
Represents an 'issuecomment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
1 property
1 required
secret-scanning-location-pull-request-title
object
Represents a 'pullrequesttitle' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
1 property
1 required
deploy-key
object
An SSH key granting access to a single repository.
9 properties
7 required
contributor
object
Contributor
21 properties
2 required
pull-request-simple_2
object
Pull Request Simple
36 properties
31 required
commit-comment_2
object
Commit Comment
14 properties
13 required
secret-scanning-location-pull-request-review
object
Represents a 'pullrequestreview' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
1 property
1 required
secret-scanning-alert
object
17 properties
auto-merge_2
object
The status of auto merging a pull request.
4 properties
4 required
deployment-status
object
The status of a deployment.
15 properties
11 required
secret-scanning-location-pull-request-comment
object
Represents a 'pullrequestcomment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
1 property
1 required
issue_3
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties
2 required
user-emails-response
array
The emails for the user.
user-role
array
The roles assigned to the user.
scim-enterprise-user-list
object
5 properties
5 required
user-response
object
8 properties
3 required
scim-enterprise-group-list
object
5 properties
5 required
scim-enterprise-user-response
scim-enterprise-group-response
user-name-response
object
4 properties
group-response
object
4 properties
1 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties
1 required
team-organization
object
Team Organization
48 properties
23 required
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties
15 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from GitHub 12
Other APIs GitHub publishes across the network.
GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
#List
Where this information came from
This is an independent, third-party profile of GitHub Lists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.