Repos
Download SpecInteract with GitHub Repos.
List organization repositories
Lists repositories for the specified organization.
Note: In order to see the security_and_analysis
block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."
org
string
required
The organization name. The name is not case sensitive.
type
string
Specifies the types of repositories you want returned. internal
is not yet supported when a GitHub App calls this endpoint with an installation access token.
- Enum
-
- all
- public
- private
- forks
- sources
- member
- internal
sort
string
The property to sort the results by.
- Default
- "created"
- Enum
-
- created
- updated
- pushed
- full_name
direction
string
The order to sort by. Default: asc
when using full_name
, otherwise desc
.
- Enum
-
- asc
- desc
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
array[object (Minimal Repository)]
Minimal Repository
object (Minimal Repository)
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Link
string
Create an organization repository
Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
OAuth scope requirements
When using OAuth, authorizations must include:
public_repo
scope orrepo
scope to create a public repository. Note: For GitHub AE, userepo
scope to create an internal repository.repo
scope to create a private repository
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the repository.
description
string
A short description of the repository.
homepage
string
A URL with more information about the repository.
private
boolean
Whether the repository is private.
- Default
- false
visibility
string
The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "Creating an internal repository" in the GitHub Help documentation.
The visibility
parameter overrides the private
parameter when you use both parameters with the nebula-preview
preview header.
- Enum
-
- public
- private
- internal
has_issues
boolean
Either true
to enable issues for this repository or false
to disable them.
- Default
- true
has_projects
boolean
Either true
to enable projects for this repository or false
to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false
, and if you pass true
, the API returns an error.
- Default
- true
has_wiki
boolean
Either true
to enable the wiki for this repository or false
to disable it.
- Default
- true
has_downloads
boolean
Whether downloads are enabled.
- Default
- true
- Example
- true
is_template
boolean
Either true
to make this repo available as a template repository or false
to prevent it.
- Default
- false
team_id
int
The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
auto_init
boolean
Pass true
to create an initial commit with empty README.
- Default
- false
gitignore_template
string
Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
license_template
string
Choose an open source license template that best suits your needs, and then use the license keyword as the license_template
string. For example, "mit" or "mpl-2.0".
allow_squash_merge
boolean
Either true
to allow squash-merging pull requests, or false
to prevent squash-merging.
- Default
- true
allow_merge_commit
boolean
Either true
to allow merging pull requests with a merge commit, or false
to prevent merging pull requests with merge commits.
- Default
- true
allow_rebase_merge
boolean
Either true
to allow rebase-merging pull requests, or false
to prevent rebase-merging.
- Default
- true
allow_auto_merge
boolean
Either true
to allow auto-merge on pull requests, or false
to disallow auto-merge.
- Default
- false
delete_branch_on_merge
boolean
Either true
to allow automatically deleting head branches when pull requests are merged, or false
to prevent automatic deletion. The authenticated user must be an organization owner to set this property to true
.
- Default
- false
use_squash_pr_title_as_default
boolean
deprecated
Either true
to allow squash-merge commits to use pull request title, or false
to use commit message. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
Request
Response
Response
Forbidden
Validation failed, or the endpoint has been spammed.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
Location
string
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Get a repository
The parent
and source
objects are present when the repository is a fork. parent
is the repository this repository was forked from, source
is the ultimate source for the network.
Note: In order to see the security_and_analysis
block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response