Read Repository
Get information for a repository in GitHub.
Input
Field | Definition | Type | Required |
---|---|---|---|
Repository | |||
Repository Owner | Username of the repository owner. | String | TRUE |
Repository Name | Name of the repository. | String | TRUE |
Output
Field | Definition | Type |
---|---|---|
Repository | ||
Repository ID | Unique identifier of the repository. | String |
Repository Node ID | node_id value of the repository in the GitHub API. |
String |
Repository Name | Name of the repository. | String |
Full Name |
Combined login and name of the repository; example, octocat/Hello-World .
|
String |
Owner Username | Username of the repository owner. | String |
Owner ID | Unique identifier of the repository owner. | String |
Owner Node ID | node_id value of the repository owner. |
String |
Owner Type | Type of owner of the repository. | String |
Is Private? |
Indicates whether a repository is private (True ) or public (False ).
|
Boolean |
HTML URL | URL of the repository; example, https://github.com/octocat . |
String |
Description | Short description of the repository. | String |
Is Fork? | Indicates whether a repository is forked (True ) or not (False ). |
Boolean |
Git URL | GitHub URL for the repository. | String |
SSH URL | GitHub URL for the repository for access via SSH. | String |
Clone URL | URL for a clone of the repository. | String |
Mirror URL | URL for a mirror of the repository. | String |
SVN URL | URL for the GitHub repository in SVN. | String |
Homepage | URL of the homepage for the repository. | String |
Language | Language of the repository. | String |
Forks Count | Number of forks of the repository. | Number |
Stargazers Count | Number of users who have starred the repository. | Number |
Watchers Count | Number of users who are watching the repository. | Number |
Size | Size of the repository (including all of its history), in kilobytes. | Number |
Default Branch |
Indicates the default branch of the repository; example, Main .
|
String |
Open Issues Count | Number of open issues in the repository | Number |
Has Issues? | Indicates whether the repository can have issues; options are true to enable issues, or false to disable them. |
Boolean |
Has Projects? |
Indicates whether the repository can have projects; options are true to enable projects, or false to disable them.
![]() 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. |
Boolean |
Has Wiki? | Indicates whether the repository can have a wiki; options are true to enable the wiki, or false to disable it. |
Boolean |
Has Pages? | Indicates whether a repository has Pages (True ) or not (False ). |
Boolean |
Has Downloads? | Indicates whether a repository has Downloads (True ) or not (False ). |
Boolean |
Is Archived? | Indicates whether a repository is archived (True ) or not (False ). |
Boolean |
Is Disabled? | Indicates whether the repository is disabled (True ) or not (False ). |
Boolean |
Pushed At | Date and time when contents were last pushed in the repository. | Date & Time |
Created At |
Date and time when the object was created. |
Date & Time |
Updated At | Date and time when the repository was last updated. | Date & Time |
Permissions | Indicates whether admin, push, and pull rights are allowed in the repository; options are True if each right is allowed, False otherwise. |
Object |
Allow Rebase Merge? | Indicates whether to allow rebase-merging pull requests; options are True to allow rebase-merging pull requests, or False to prevent rebase-merging. |
Boolean |
Temp Clone Token | Temporary access token to clone the repository from GitHub. | String |
Allow Squash Merge? | Indicates whether to allow squash-merging pull requests; options are True to allow squash-merging pull requests, or False to prevent squash-merging. |
Boolean |
Delete Branch on Merge? | Indicates whether to allow automatically deleting head branches when pull requests are merged; options are True to allow automatically deleting head branches when pull requests are merged, or False to prevent automatic deletion. |
Boolean |
Allow Merge Commit? | Indicates whether to allow merging pull requests with a merge commit; options are True to allow merging pull requests with a merge commit, or False to prevent merging pull requests with merge commits. |
Boolean |
Subscribers Count | Number of users who have subscribed to the repository. | Number |
Network Count | Size of the repository's network. | Number |
License | Value of the license for a repository. | String |
Organization Username | User name of the organization to which the repository belongs. | String |
Organization ID | Unique identifier of the organization to which the repository belongs. | String |
Organization Node ID | node_id value of the organization to which the repository belongs. |
String |
Organization HTML URL | URL of the organization to which the repository belongs. | String |
Parent repository | Parent repository to which the repository belongs. | String |
Source | Source branch and directory of the repository. | String |