GitHub v3 REST API

Rate Limit Overview

object

Rate Limit Overview

resourcesobjectrequired
Show Child Parameters
rateobjectrequired
Show Child Parameters
Example

Code Of Conduct Simple

object

Code of Conduct Simple

urlstring(uri)required

Example:https://api.github.com/repos/github/docs/community/code_of_conduct

keystringrequired

Example:citizen_code_of_conduct

namestringrequired

Example:Citizen Code of Conduct

html_urlstring(uri)required

Example:https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md

Example

Full Repository

object

Full Repository

idintegerrequired

Example:1296269

node_idstringrequired

Example:MDEwOlJlcG9zaXRvcnkxMjk2MjY5

namestringrequired

Example:Hello-World

full_namestringrequired

Example:octocat/Hello-World

ownerobjectrequired

Simple User

Show Child Parameters
privatebooleanrequired
html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World

descriptionstringrequired

Example:This your first repo!

forkbooleanrequired
urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World

archive_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

assignees_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/branches{/branch}

collaborators_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/contributors

deployments_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/deployments

downloads_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/downloads

events_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/events

forks_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/forks

git_commits_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_urlstringrequired

Example:git:github.com/octocat/Hello-World.git

issue_comment_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/labels{/name}

languages_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/languages

merges_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/merges

milestones_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/milestones{/number}

notifications_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

pulls_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/pulls{/number}

releases_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/releases{/id}

ssh_urlstringrequired

Example:git@github.com:octocat/Hello-World.git

stargazers_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/subscription

tags_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/tags

teams_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/teams

trees_urlstringrequired

Example:http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

clone_urlstringrequired

Example:https://github.com/octocat/Hello-World.git

mirror_urlstring(uri)required

Example:git:git.example.com/octocat/Hello-World

hooks_urlstring(uri)required

Example:http://api.github.com/repos/octocat/Hello-World/hooks

svn_urlstring(uri)required

Example:https://svn.github.com/octocat/Hello-World

homepagestring(uri)required

Example:https://github.com

languagestringrequired
forks_countintegerrequired

Example:9

stargazers_countintegerrequired

Example:80

watchers_countintegerrequired

Example:80

sizeintegerrequired

Example:108

default_branchstringrequired

Example:master

open_issues_countintegerrequired
is_templateboolean

Example:true

topicsarray[string]

Example:octocat, atom, electron, API

has_issuesbooleanrequired

Example:true

has_projectsbooleanrequired

Example:true

has_wikibooleanrequired

Example:true

has_pagesbooleanrequired
has_downloadsbooleanrequired

Example:true

archivedbooleanrequired
disabledbooleanrequired

Returns whether or not this repository disabled.

visibilitystring

The repository visibility: public, private, or internal.

Example:public

pushed_atstring(date-time)required

Example:2011-01-26T19:06:43Z

created_atstring(date-time)required

Example:2011-01-26T19:01:12Z

updated_atstring(date-time)required

Example:2011-01-26T19:14:43Z

permissionsobject
Show Child Parameters
allow_rebase_mergeboolean

Example:true

template_repositoryobject

A git repository

Show Child Parameters
temp_clone_tokenstring
allow_squash_mergeboolean

Example:true

delete_branch_on_mergeboolean
allow_merge_commitboolean

Example:true

allow_forkingboolean

Example:true

subscribers_countintegerrequired

Example:42

network_countintegerrequired
licenseobjectrequired

License Simple

Show Child Parameters
organizationobject

Simple User

Show Child Parameters
parentobject

A git repository

Show Child Parameters
sourceobject

A git repository

Show Child Parameters
forksintegerrequired
master_branchstring
open_issuesintegerrequired
watchersintegerrequired
anonymous_access_enabledboolean

Whether anonymous git access is allowed.

Default:true

code_of_conductobject

Code of Conduct Simple

Show Child Parameters
Example

Artifact

object

An artifact

idintegerrequired

Example:5

node_idstringrequired

Example:MDEwOkNoZWNrU3VpdGU1

namestringrequired

The name of the artifact.

Example:AdventureWorks.Framework

size_in_bytesintegerrequired

The size in bytes of the artifact.

Example:12345

urlstringrequired

Example:https://api.github.com/repos/github/hello-world/actions/artifacts/5

archive_download_urlstringrequired

Example:https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip

expiredbooleanrequired

Whether or not the artifact has expired.

created_atstring(date-time)required
expires_atstring(date-time)required
updated_atstring(date-time)required
Example

Job

object

Information of a job execution in a workflow run

idintegerrequired

The id of the job.

Example:21

run_idintegerrequired

The id of the associated workflow run.

Example:5

run_urlstringrequired

Example:https://api.github.com/repos/github/hello-world/actions/runs/5

run_attemptinteger

Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.

Example:1

node_idstringrequired

Example:MDg6Q2hlY2tSdW40

head_shastringrequired

The SHA of the commit that is being run.

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

urlstringrequired

Example:https://api.github.com/repos/github/hello-world/actions/jobs/21

html_urlstringrequired

Example:https://github.com/github/hello-world/runs/4

statusstringrequired

The phase of the lifecycle that the job is currently in.

Allowed values:queuedin_progresscompleted

Example:queued

conclusionstringrequired

The outcome of the job.

Example:success

started_atstring(date-time)required

The time that the job started, in ISO 8601 format.

Example:2019-08-08T08:00:00-07:00

completed_atstring(date-time)required

The time that the job finished, in ISO 8601 format.

Example:2019-08-08T08:00:00-07:00

namestringrequired

The name of the job.

Example:test-coverage

stepsarray[object]

Steps in this job.

Show Child Parameters
check_run_urlstringrequired

Example:https://api.github.com/repos/github/hello-world/check-runs/4

Example