ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|---|---|---|
write_permissions | list<string> | Write permissions granted upon app installation | |
app_id | number | App ID | |
created_at | number | Created time of the App in Unix Timestamp format | |
repository_selection | string | Repository access selection | |
updated_at | number | Updated time of the App in Unix Timestamp format | |
read_permissions | list<string> | Read permissions granted upon app installation | |
webhook_events | list<string> | Subscribe to webhook events upon app installation | |
installation_id | number | Installation ID | |
app_name | string | App name | |
app_slug | string | App URL-friendly name |
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|---|---|---|
resourcePath | string | The HTTP path for this user resource | |
isHireable | boolean | Whether or not the user has marked themselves as for hire | |
pinnedItemsRemaining | number | Returns how many more items this profile owner can pin to their profile | |
isViewer | boolean | Whether or not this user is the viewing user | |
viewerCanSponsor | boolean | Whether or not the viewer is able to sponsor this user/organization | |
location | string | The user's public profile location | |
name | string | The user's public profile name | |
viewerCanCreateProjects | boolean | Can the current viewer create new projects on this owner? | |
isEmployee | boolean | Whether or not this user is a GitHub employee | |
repositoriesContributedTo | object | A list of repositories that the user recently contributed to | |
totalCount | number | Identifies the total count of pullRequests associated with the user | |
totalDiskUsage | number | The total size in kilobytes of all repositories associated with the user | |
databaseId | number | Identifies the primary key from the database | |
isDeveloperProgramMember | boolean | Whether or not this user is a GitHub Developer Program member | |
isSponsoringViewer | boolean | Whether or not the viewer is sponsored by this user/organization | |
id | string | ID of the user | |
pronouns | string | The user's profile pronouns | |
recentProjects | object | Recent projects that this user has modified in the context of the owner | |
totalCount | number | Identifies the total count of recentProjects associated with the user | |
monthlyEstimatedSponsorsIncomeInCents | number | The estimated monthly GitHub Sponsors income for this user in cents (USD) | |
isGitHubStar | boolean | Whether or not this user is a member of the GitHub Stars Program | |
repositories | object | A list of repositories that the user owns | |
totalCount | number | Identifies the total count of the public repositories owned by the user | |
bio | string | The user's public profile bio | |
websiteUrl | string | A URL pointing to the user's public website/blog | |
pullRequests | object | A list of pull requests associated with this user | |
totalCount | number | Identifies the total count of pullRequests associated with the user | |
following | object | A list of users the given user is following | |
totalCount | number | Identifies the total count of the users the current user is following | |
isBountyHunter | boolean | Whether or not this user is a participant in the GitHub Security Bug Bounty | |
company | string | The user's public profile company | |
isSiteAdmin | boolean | Whether or not this user is a site administrator | |
viewerCanChangePinnedItems | boolean | Can the viewer pin repositories and gists to the profile? | |
updatedAt | string | Identifies the date and time when the user was last updated | |
role | string | The role this user has in the organization | |
viewerIsFollowing | boolean | Whether or not this user is followed by the viewer | |
viewerIsSponsoring | boolean | Whether or not the viewer is sponsoring this user | |
anyPinnableItems | boolean | Determine if this repository owner has any items that can be pinned to their profile | |
hasSponsorsListing | boolean | Whether or not this user has a GitHub Sponsors listing | |
projectsUrl | string | The HTTP URL listing user's projects | |
status | object | The user's description of what they're currently doing | |
message | string | A brief message describing what the user is doing | |
expiresAt | string | If set, the status will not be shown after this date | |
updatedAt | string | Identifies the date and time when the object was last updated | |
indicatesLimitedAvailability | boolean | Whether this status indicates the user is not fully available on GitHub | |
createdAt | string | Identifies the date and time when the status was created | |
followers | object | A list of users the given user is followed by | |
totalCount | number | Identifies the total count of the users who follow the current user | |
hasTwoFactorEnabled | boolean | Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer | |
isCampusExpert | boolean | Whether or not this user is a participant in the GitHub Campus Experts Program | |
twitterUsername | string | The user's Twitter username | |
string | The user's publicly visible profile email | ||
avatarUrl | string | A URL pointing to the user's public avatar | |
bioHTML | string | The user's public profile bio as HTML | |
isFollowingViewer | boolean | Whether or not this user is following the viewer | |
viewerCanFollow | boolean | Whether or not the viewer is able to follow the user | |
login | string | The username used to login | |
estimatedNextSponsorsPayoutInCents | number | The estimated next GitHub Sponsors payout for this user/organization in cents (USD) | |
canReceiveOrganizationEmailsWhenNotificationsRestricted | boolean | Could this user receive email notifications, if the organization had notification restrictions enabled? | |
url | string | The HTTP URL for this user | |
createdAt | string | Identifies the date and time when the user was created | |
companyHTML | string | The user's public profile company as HTML |
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|---|---|---|
name | string | Organization name | |
public_gists_count | number | Number of Public Gists for an organization | |
two_factor_requirement_enabled | boolean | Whether the organization requires 2FA for all users | |
has_inactive_admin_users | boolean | Whether the organization has inactive admin users | |
has_inactive_users | boolean | Whether the organization has inactive users | |
has_2fa_disable_users | boolean | Whether the organization has users with 2FA disabled | |
default_repository_permission | string | Default permission level members have for organization repositories. * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default. Default: read |
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|---|---|---|
name | string | Repository name | |
full_name | string | Repository full name | |
has_projects_enabled | boolean | Indicates if the repository has the Projects feature enabled. | |
is_template | boolean | Identifies if the repository is a template that can be used to generate new repositories. | |
delete_branch_on_merge | boolean | Whether or not branches are automatically deleted when merged in this repository. | |
has_wiki_enabled | boolean | Indicates if the repository has wiki feature enabled. | |
merge_commit_title | string | How the default commit title will be generated when merging a pull request. | |
rebase_merge_allowed | boolean | Whether or not rebase-merging is enabled on this repository. | |
is_archived | boolean | Indicates if the repository is unmaintained. | |
is_mirror | boolean | Identifies if the repository is a mirror. | |
merge_commit_message | string | How the default commit message will be generated when merging a pull request. | |
squash_merge_allowed | boolean | Whether or not squash-merging is enabled on this repository. | |
viewer_has_starred | boolean | Returns a boolean indicating whether the viewing user has starred this starrable. | |
viewer_subscription | string | Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. | |
uses_custom_open_graph_image | boolean | Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar. | |
viewer_can_create_projects | boolean | Can the current viewer create new projects on this owner. | |
viewer_permission | string | The users permission level on the repository. Will return null if authenticated as an GitHub App. | |
default_branch | object | The Repository's default branch | |
name | string | Branch name | |
has_gitignore_file | boolean | Whether the default branch has a .gitignore file. | |
has_codeowners_file | boolean | Whether the default branch has a CODEOWNERS file. | |
has_license_file | boolean | Whether the default branch has a LICENSE file. | |
protection_rule | object | Branch protection rule | |
requires_approving_reviews | boolean | Are approving reviews required to update matching branches. | |
requires_status_checks | boolean | Are status checks required to update matching branches. | |
dismisses_stale_reviews | boolean | Will new commits pushed to matching branches dismiss pull request review approvals. | |
allow_force_pushes | boolean | Allow force pushing to the branch | |
allow_deletions | boolean | Allow branch deletions | |
required_approving_review_count | number | Number of approving reviews required to update matching branches. | |
archived_at | number | Identifies the date and time when the repository was archived. | |
has_discussions_enabled | boolean | Indicates if the repository has the Discussions feature enabled. | |
lock_reason | string | The reason the repository has been locked. | |
squash_merge_commit_message | string | How the default commit message will be generated when squash merging a pull request. | |
private | boolean | Whether a repository is private or not | |
branch_protection_enabled_for_all_branches | boolean | Whether branch protection is enabled for all branches | |
is_user_configuration_repository | boolean | Is this repository a user configuration repository? | |
auto_merge_allowed | boolean | Whether or not Auto-merge can be enabled on pull requests in this repository. | |
is_blank_issues_enabled | boolean | Returns true if blank issue creation is allowed. | |
is_fork | boolean | Identifies if the repository is a fork. | |
visibility | string | Indicates the repository's visibility level. | |
fork_count | number | The number of forks of this repository | |
viewer_default_merge_method | string | The last used merge method by the viewer or the default for the repository. | |
created_at | number | Repository's creation time in Unix Timestamp format | |
has_outside_collaborators | boolean | Returns true if this repository has external collaborators. | |
squash_merge_commit_title | string | How the default commit title will be generated when squash merging a pull request. | |
web_commit_signoff_required | boolean | Whether contributors are required to sign off on web-based commits in this repository. | |
is_security_policy_enabled | boolean | Returns true if this repository has a security policy. | |
description | string | The description of the repository. | |
has_issues_enabled | boolean | Indicates if the repository has issues feature enabled. | |
merge_commit_allowed | boolean | Whether or not PRs are merged with a merge commit on this repository. | |
pushed_at | number | The last time a commit was pushed to a repository, in Unix Timestamp format | |
branch_protection_rule_bypass_admin_user | boolean | Whether any branch protection rule bypasses an admin user | |
forking_allowed | boolean | Whether this repository allows forks. | |
has_vulnerability_alerts_enabled | boolean | Whether vulnerability alerts are enabled for the repository. | |
is_locked | boolean | Indicates if the repository has been locked or not. | |
parent | object | The repository parent, if this is a fork. | |
id | string | The Node ID of the Repository object. | |
name | string | The name of the repository. | |
stargazer_count | number | Returns a count of how many stargazers there are on this object. | |
is_empty | boolean | Returns whether or not this repository is empty. | |
viewer_can_administer | boolean | Indicates whether the viewer has admin permissions on this repository. | |
viewer_can_update_topics | boolean | Indicates whether the viewer can update the topics of this repository. | |
interaction_ability | object | The interaction ability settings for this repository. | |
limit | string | The current limit that is enabled on this object. | |
origin | string | The origin of the currently active interaction limit. | |
expiresAt | string | The time the currently active limit expires. | |
is_in_organization | boolean | Indicates if a repository is either owned by an organization, or is a private fork of an organization repository. | |
owner | object | The User owner of the repository. | |
id | string | The Node ID of the RepositoryOwner object. | |
login | string | The username used to login. | |
template_repository | object | The repository from which this repository was generated, if any. | |
name | string | The name of the repository. | |
id | string | The Node ID of the Repository object. | |
viewer_can_subscribe | boolean | Check if the viewer is able to change their subscription status for the repository. | |
secret_scanning_enabled | boolean | Whether secret scanning is enabled | |
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. | |
disk_usage | number | The number of kilobytes this repository occupies on disk. | |
is_disabled | boolean | Returns whether or not this repository disabled. | |
primary_language | object | The primary language of the repository's code. | |
name | string | The name of the current language. | |
color | string | The color defined for the current language. | |
id | string | The Node ID of the Language object. |
ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
---|