Operations (sample payloads)

Main operations
Copy

Add/update team membership
Copy

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

Sample Input

1{
2    "org_and_team": {
3        "organization": "acme-corp",
4        "team_slug": "developers"
5    },
6    "username": "johndoe",
7    "role": "member"
8}

Sample Output

1{
2    "state": "active",
3    "role": "member",
4    "url": "https://api.github.com/teams/1234567/memberships/johndoe"
5}

Create a release
Copy

Creates a release on a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "tag_name": "v1.0.0",
5    "target_commitish": "master",
6    "name": "Release v1.0.0",
7    "body": "This is the first stable release of our project.",
8    "draft": false,
9    "prerelease": false
10}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
3    "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
4    "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
5    "html_url": "https://github.com/octocat/Hello-World/releases/tag/v1.0.0",
6    "id": 1,
7    "node_id": "MDc6UmVsZWFzZTE=",
8    "tag_name": "v1.0.0",
9    "target_commitish": "master",
10    "name": "Release v1.0.0",
11    "draft": false,
12    "author": {
13        "login": "octocat",
14        "id": 1,
15        "node_id": "MDQ6VXNlcjE=",
16        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
17        "gravatar_id": "",
18        "url": "https://api.github.com/users/octocat",
19        "html_url": "https://github.com/octocat",
20        "followers_url": "https://api.github.com/users/octocat/followers",
21        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
22        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
23        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
25        "organizations_url": "https://api.github.com/users/octocat/orgs",
26        "repos_url": "https://api.github.com/users/octocat/repos",
27        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
28        "received_events_url": "https://api.github.com/users/octocat/received_events",
29        "type": "User",
30        "site_admin": false
31    },
32    "prerelease": false,
33    "created_at": "2023-05-15T12:00:00Z",
34    "published_at": "2023-05-15T12:00:00Z",
35    "assets": [],
36    "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
37    "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
38    "body": "This is the first stable release of our project."
39}

Create a status
Copy

Creates a status on a GitHub ref.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
5    "state": "success",
6    "target_url": "https://ci.example.com/1000/output",
7    "description": "The build succeeded!",
8    "context": "continuous-integration/jenkins"
9}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
3    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
4    "id": 1234567890,
5    "node_id": "MDY6U3RhdHVzMTIzNDU2Nzg5MA==",
6    "state": "success",
7    "description": "The build succeeded!",
8    "target_url": "https://ci.example.com/1000/output",
9    "context": "continuous-integration/jenkins",
10    "created_at": "2023-05-05T12:34:56Z",
11    "updated_at": "2023-05-05T12:34:56Z",
12    "creator": {
13        "login": "octocat",
14        "id": 1,
15        "node_id": "MDQ6VXNlcjE=",
16        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
17        "gravatar_id": "",
18        "url": "https://api.github.com/users/octocat",
19        "html_url": "https://github.com/octocat",
20        "followers_url": "https://api.github.com/users/octocat/followers",
21        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
22        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
23        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
25        "organizations_url": "https://api.github.com/users/octocat/orgs",
26        "repos_url": "https://api.github.com/users/octocat/repos",
27        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
28        "received_events_url": "https://api.github.com/users/octocat/received_events",
29        "type": "User",
30        "site_admin": false
31    }
32}

Create deploy key
Copy

Creates a deploy key for a specified repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "title": "Deploy key for production server",
5    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHZYaOWfxzrOuCZRKdRobGjC9mxI6vFKlNlHbMNMWAOLd7kPpgBTOWMsNlkZAP4Ux/rjZojUcrnbm8tpjrConfR4y+bxwKU/sEEUgBh4B8ByC3snpI/A1L8yiBpvNIj7E5yKasWxvCxGx+XUFQNIzxkGSPqd3qZWfD/YTuhZQ0CTs2JvKl9QaGyS+3ZYK2Ue+YYgHvRXD+9WKmAXeGN5a8yFUz5LpfGwHZ5VsIzH/i3tVNWbzOhTi2/xkZBLwkWPUjGKhzz7QFTTj9tK0GBZ5NHaXEcVKC4DcEcwkOHHx7OjozxQxTg7Ym/ZK4TjSGUgb6WW/i0lD2PNhH6Y5QjYvP",
6    "read_only": true
7}

Sample Output

1{
2    "id": 1234567,
3    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHZYaOWfxzrOuCZRKdRobGjC9mxI6vFKlNlHbMNMWAOLd7kPpgBTOWMsNlkZAP4Ux/rjZojUcrnbm8tpjrConfR4y+bxwKU/sEEUgBh4B8ByC3snpI/A1L8yiBpvNIj7E5yKasWxvCxGx+XUFQNIzxkGSPqd3qZWfD/YTuhZQ0CTs2JvKl9QaGyS+3ZYK2Ue+YYgHvRXD+9WKmAXeGN5a8yFUz5LpfGwHZ5VsIzH/i3tVNWbzOhTi2/xkZBLwkWPUjGKhzz7QFTTj9tK0GBZ5NHaXEcVKC4DcEcwkOHHx7OjozxQxTg7Ym/ZK4TjSGUgb6WW/i0lD2PNhH6Y5QjYvP",
4    "url": "https://api.github.com/repos/octocat/Hello-World/keys/1234567",
5    "title": "Deploy key for production server",
6    "verified": true,
7    "created_at": "2023-05-15T12:34:56Z",
8    "read_only": true
9}

Create issue
Copy

Creates an issue on a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "title": "Found a bug",
5    "body": "I'm having a problem with this.",
6    "milestone": 1,
7    "labels": [
8        "bug",
9        "high-priority"
10    ],
11    "assignees": [
12        "octocat",
13        "hubot"
14    ]
15}

Sample Output

1{
2    "name": "main",
3    "commit": {
4        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
5        "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
6        "commit": {
7            "author": {
8                "name": "Monalisa Octocat",
9                "email": "mona@github.com",
10                "date": "2011-04-14T16:00:49Z"
11            },
12            "committer": {
13                "name": "GitHub",
14                "email": "noreply@github.com",
15                "date": "2011-04-14T16:00:49Z"
16            },
17            "message": "Fix all the bugs",
18            "tree": {
19                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
20                "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/6dcb09b5b57875f334f61aebed695e2e4193db5e"
21            },
22            "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
23            "comment_count": 0,
24            "verification": {
25                "verified": true,
26                "reason": "valid",
27                "signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----",
28                "payload": "tree 6dcb09b5b57875f334f61aebed695e2e4193db5e\n..."
29            }
30        },
31        "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
32        "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
33        "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
34        "author": {
35            "login": "octocat",
36            "id": 1,
37            "node_id": "MDQ6VXNlcjE=",
38            "avatar_url": "https://github.com/images/error/octocat_happy.gif",
39            "gravatar_id": "",
40            "url": "https://api.github.com/users/octocat",
41            "html_url": "https://github.com/octocat",
42            "followers_url": "https://api.github.com/users/octocat/followers",
43            "following_url": "https://api.github.com/users/octocat/following{/other_user}",
44            "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
45            "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
46            "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
47            "organizations_url": "https://api.github.com/users/octocat/orgs",
48            "repos_url": "https://api.github.com/users/octocat/repos",
49            "events_url": "https://api.github.com/users/octocat/events{/privacy}",
50            "received_events_url": "https://api.github.com/users/octocat/received_events",
51            "type": "User",
52            "site_admin": false
53        },
54        "committer": {
55            "login": "web-flow",
56            "id": 19864447,
57            "node_id": "MDQ6VXNlcjE5ODY0NDQ3",
58            "avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4",
59            "gravatar_id": "",
60            "url": "https://api.github.com/users/web-flow",
61            "html_url": "https://github.com/web-flow",
62            "followers_url": "https://api.github.com/users/web-flow/followers",
63            "following_url": "https://api.github.com/users/web-flow/following{/other_user}",
64            "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
65            "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
66            "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
67            "organizations_url": "https://api.github.com/users/web-flow/orgs",
68            "repos_url": "https://api.github.com/users/web-flow/repos",
69            "events_url": "https://api.github.com/users/web-flow/events{/privacy}",
70            "received_events_url": "https://api.github.com/users/web-flow/received_events",
71            "type": "User",
72            "site_admin": false
73        },
74        "parents": [
75            {
76                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
77                "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
78                "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e"
79            }
80        ]
81    },
82    "_links": {
83        "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
84        "html": "https://github.com/octocat/Hello-World/tree/main"
85    },
86    "protected": true,
87    "protection": {
88        "enabled": true,
89        "required_status_checks": {
90            "enforcement_level": "non_admins",
91            "contexts": [
92                "ci/travis"
93            ]
94        }
95    },
96    "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
97}

Create repository
Copy

Create a new repository.

Sample Input

1{
2    "name": "my-awesome-project",
3    "description": "This repository contains my awesome project",
4    "homepage": "https://myawesomeproject.com",
5    "private": false,
6    "has_issues": true,
7    "has_projects": true,
8    "has_wiki": true,
9    "allow_squash_merge": true,
10    "allow_merge_commit": true,
11    "allow_rebase_merge": true,
12    "auto_init": true,
13    "gitignore_template": "Node",
14    "license_template": "mit"
15}

Sample Output

1{
2    "id": 123456789,
3    "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
4    "name": "my-awesome-project",
5    "full_name": "octocat/my-awesome-project",
6    "private": false,
7    "owner": {
8        "login": "octocat",
9        "id": 1234567,
10        "node_id": "MDQ6VXNlcjEyMzQ1Njc=",
11        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
12        "gravatar_id": "",
13        "url": "https://api.github.com/users/octocat",
14        "html_url": "https://github.com/octocat",
15        "followers_url": "https://api.github.com/users/octocat/followers",
16        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
17        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
18        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
20        "organizations_url": "https://api.github.com/users/octocat/orgs",
21        "repos_url": "https://api.github.com/users/octocat/repos",
22        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
23        "received_events_url": "https://api.github.com/users/octocat/received_events",
24        "type": "User",
25        "site_admin": false
26    },
27    "html_url": "https://github.com/octocat/my-awesome-project",
28    "description": "This repository contains my awesome project",
29    "fork": false,
30    "url": "https://api.github.com/repos/octocat/my-awesome-project",
31    "forks_url": "https://api.github.com/repos/octocat/my-awesome-project/forks",
32    "keys_url": "https://api.github.com/repos/octocat/my-awesome-project/keys{/key_id}",
33    "collaborators_url": "https://api.github.com/repos/octocat/my-awesome-project/collaborators{/collaborator}",
34    "teams_url": "https://api.github.com/repos/octocat/my-awesome-project/teams",
35    "hooks_url": "https://api.github.com/repos/octocat/my-awesome-project/hooks",
36    "issue_events_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/events{/number}",
37    "events_url": "https://api.github.com/repos/octocat/my-awesome-project/events",
38    "assignees_url": "https://api.github.com/repos/octocat/my-awesome-project/assignees{/user}",
39    "branches_url": "https://api.github.com/repos/octocat/my-awesome-project/branches{/branch}",
40    "tags_url": "https://api.github.com/repos/octocat/my-awesome-project/tags",
41    "blobs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/blobs{/sha}",
42    "git_tags_url": "https://api.github.com/repos/octocat/my-awesome-project/git/tags{/sha}",
43    "git_refs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/refs{/sha}",
44    "trees_url": "https://api.github.com/repos/octocat/my-awesome-project/git/trees{/sha}",
45    "statuses_url": "https://api.github.com/repos/octocat/my-awesome-project/statuses/{sha}",
46    "languages_url": "https://api.github.com/repos/octocat/my-awesome-project/languages",
47    "stargazers_url": "https://api.github.com/repos/octocat/my-awesome-project/stargazers",
48    "contributors_url": "https://api.github.com/repos/octocat/my-awesome-project/contributors",
49    "subscribers_url": "https://api.github.com/repos/octocat/my-awesome-project/subscribers",
50    "subscription_url": "https://api.github.com/repos/octocat/my-awesome-project/subscription",
51    "commits_url": "https://api.github.com/repos/octocat/my-awesome-project/commits{/sha}",
52    "git_commits_url": "https://api.github.com/repos/octocat/my-awesome-project/git/commits{/sha}",
53    "comments_url": "https://api.github.com/repos/octocat/my-awesome-project/comments{/number}",
54    "issue_comment_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/comments{/number}",
55    "contents_url": "https://api.github.com/repos/octocat/my-awesome-project/contents/{+path}",
56    "compare_url": "https://api.github.com/repos/octocat/my-awesome-project/compare/{base}...{head}",
57    "merges_url": "https://api.github.com/repos/octocat/my-awesome-project/merges",
58    "archive_url": "https://api.github.com/repos/octocat/my-awesome-project/{archive_format}{/ref}",
59    "downloads_url": "https://api.github.com/repos/octocat/my-awesome-project/downloads",
60    "issues_url": "https://api.github.com/repos/octocat/my-awesome-project/issues{/number}",
61    "pulls_url": "https://api.github.com/repos/octocat/my-awesome-project/pulls{/number}",
62    "milestones_url": "https://api.github.com/repos/octocat/my-awesome-project/milestones{/number}",
63    "notifications_url": "https://api.github.com/repos/octocat/my-awesome-project/notifications{?since,all,participating}",
64    "labels_url": "https://api.github.com/repos/octocat/my-awesome-project/labels{/name}",
65    "releases_url": "https://api.github.com/repos/octocat/my-awesome-project/releases{/id}",
66    "deployments_url": "https://api.github.com/repos/octocat/my-awesome-project/deployments",
67    "created_at": "2023-05-15T12:00:00Z",
68    "updated_at": "2023-05-15T12:00:00Z",
69    "pushed_at": "2023-05-15T12:00:00Z",
70    "git_url": "git://github.com/octocat/my-awesome-project.git",
71    "ssh_url": "git@github.com:octocat/my-awesome-project.git",
72    "clone_url": "https://github.com/octocat/my-awesome-project.git",
73    "svn_url": "https://github.com/octocat/my-awesome-project",
74    "homepage": "https://myawesomeproject.com",
75    "size": 0,
76    "stargazers_count": 0,
77    "watchers_count": 0,
78    "language": null,
79    "has_issues": true,
80    "has_projects": true,
81    "has_downloads": true,
82    "has_wiki": true,
83    "has_pages": false,
84    "forks_count": 0,
85    "mirror_url": null,
86    "archived": false,
87    "disabled": false,
88    "open_issues_count": 0,
89    "license": {
90        "key": "mit",
91        "name": "MIT License",
92        "spdx_id": "MIT",
93        "url": "https://api.github.com/licenses/mit",
94        "node_id": "MDc6TGljZW5zZTEz"
95    },
96    "forks": 0,
97    "open_issues": 0,
98    "watchers": 0,
99    "default_branch": "main",
100    "permissions": {
101        "admin": true,
102        "push": true,
103        "pull": true
104    },
105    "allow_squash_merge": true,
106    "allow_merge_commit": true,
107    "allow_rebase_merge": true,
108    "delete_branch_on_merge": false,
109    "network_count": 0,
110    "subscribers_count": 1
111}

Delete deploy key
Copy

Deletes a specified deploy key.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "key_id": 1234567
5}

Sample Output

1{
2    "id": 1234567,
3    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
4    "url": "https://api.github.com/repos/octocat/Hello-World/keys/1234567",
5    "title": "octocat@octomac",
6    "verified": true,
7    "created_at": "2014-12-10T15:53:42Z",
8    "read_only": true
9}

Delete repository
Copy

Delete a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World"
4}

Sample Output

1{
2    "success": true
3}

Get a single reference
Copy

Retrieves a single reference from your Git database.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "reference": "heads/main"
5}

Sample Output

1{
2    "ref": "refs/heads/main",
3    "node_id": "MDM6UmVmcmVmczovbWFpbg==",
4    "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/main",
5    "object": {
6        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
7        "type": "commit",
8        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
9    }
10}

Get branch
Copy

Retrieves the branch of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "branch": "main"
5}

Sample Output

1{
2    "name": "main",
3    "commit": {
4        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
5        "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
6        "commit": {
7            "author": {
8                "name": "Monalisa Octocat",
9                "date": "2011-04-14T16:00:49Z",
10                "email": "mona@github.com"
11            },
12            "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
13            "message": "Fix all the bugs",
14            "tree": {
15                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
16                "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/6dcb09b5b57875f334f61aebed695e2e4193db5e"
17            },
18            "committer": {
19                "name": "Monalisa Octocat",
20                "date": "2011-04-14T16:00:49Z",
21                "email": "mona@github.com"
22            },
23            "verification": {
24                "verified": true,
25                "reason": "valid",
26                "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJV+XSgCRBK7hj4Ov3rIwAAdHIIAGSYI9oq8iVbKmPTHe9fvlG4\nF4Wc3jgRTZOKzW3zO/0xojo+jXM8RnCNBtHYT32xAoIQVUE4HA8brnZvkOjYkSFq\nB6vzKB+bMEWd0zc0+Wnxcm8jiyt4sWzkqX2wYHsVe1O0HBkHE2Gk6Zf2IyOTJQlf\n7wTRISNNLKx7rS7qHvR+3Jw9jT1lfyVvVmGKYLtjlZ1WEHINHVqL5x9V6qc3pGXF\nQY+D0QIcIjOVPiXD/zI/X6HKmnH3Y6JKklFCT1vt/YwqLZwgmU9n1vSHqi/kEDlG\nYjx+CO4Zk55bp4wZS8/rRt4J1bnxAhszpnKiHAXM62Qj/uPtUoGbhJlr1V8=\n=FXTr\n-----END PGP SIGNATURE-----\n",
27                "payload": "tree 6dcb09b5b57875f334f61aebed695e2e4193db5e\nparent 6dcb09b5b57875f334f61aebed695e2e4193db5e\nauthor Monalisa Octocat <mona@github.com> 1302808849 +0000\ncommitter Monalisa Octocat <mona@github.com> 1302808849 +0000\n\nFix all the bugs"
28            }
29        },
30        "author": {
31            "gravatar_id": "",
32            "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
33            "url": "https://api.github.com/users/octocat",
34            "id": 583231,
35            "login": "octocat"
36        },
37        "parents": [
38            {
39                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
40                "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
41            }
42        ],
43        "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
44        "committer": {
45            "gravatar_id": "",
46            "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
47            "url": "https://api.github.com/users/octocat",
48            "id": 583231,
49            "login": "octocat"
50        }
51    },
52    "_links": {
53        "html": "https://github.com/octocat/Hello-World/tree/main",
54        "self": "https://api.github.com/repos/octocat/Hello-World/branches/main"
55    },
56    "protected": false,
57    "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
58}

Get branch protection
Copy

Retrieves the GitHub branch protection rules of a branch on a repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "branch": "main"
5}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
3    "required_status_checks": {
4        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks",
5        "strict": true,
6        "contexts": [
7            "continuous-integration/travis-ci",
8            "codecov/patch",
9            "codecov/project"
10        ],
11        "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks/contexts"
12    },
13    "restrictions": {
14        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions",
15        "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/users",
16        "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/teams",
17        "users": [
18            {
19                "login": "octocat",
20                "id": 1,
21                "node_id": "MDQ6VXNlcjE=",
22                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
23                "gravatar_id": "",
24                "url": "https://api.github.com/users/octocat",
25                "html_url": "https://github.com/octocat",
26                "followers_url": "https://api.github.com/users/octocat/followers",
27                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
28                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
29                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
30                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
31                "organizations_url": "https://api.github.com/users/octocat/orgs",
32                "repos_url": "https://api.github.com/users/octocat/repos",
33                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
34                "received_events_url": "https://api.github.com/users/octocat/received_events",
35                "type": "User",
36                "site_admin": false
37            }
38        ],
39        "teams": [
40            "core-team"
41        ]
42    },
43    "required_pull_request_reviews": {
44        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_pull_request_reviews",
45        "dismiss_stale_reviews": true,
46        "require_code_owner_reviews": true,
47        "dismissal_restrictions": {
48            "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions",
49            "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/users",
50            "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/teams",
51            "users": [
52                {
53                    "login": "octocat",
54                    "id": 1,
55                    "node_id": "MDQ6VXNlcjE=",
56                    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
57                    "gravatar_id": "",
58                    "url": "https://api.github.com/users/octocat",
59                    "html_url": "https://github.com/octocat",
60                    "followers_url": "https://api.github.com/users/octocat/followers",
61                    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
62                    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
63                    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
64                    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
65                    "organizations_url": "https://api.github.com/users/octocat/orgs",
66                    "repos_url": "https://api.github.com/users/octocat/repos",
67                    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
68                    "received_events_url": "https://api.github.com/users/octocat/received_events",
69                    "type": "User",
70                    "site_admin": false
71                }
72            ],
73            "teams": [
74                "core-team"
75            ]
76        }
77    },
78    "enforce_admins": {
79        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/enforce_admins",
80        "enabled": true
81    }
82}

Get commit
Copy

Get a commit in a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
5}

Sample Output

1{
2    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
3    "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
4    "commit": {
5        "author": {
6            "name": "Monalisa Octocat",
7            "email": "mona@github.com",
8            "date": "2011-04-14T16:00:49Z"
9        },
10        "committer": {
11            "name": "Monalisa Octocat",
12            "email": "mona@github.com",
13            "date": "2011-04-14T16:00:49Z"
14        },
15        "message": "Fix all the bugs",
16        "tree": {
17            "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
18            "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
19        },
20        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
21        "comment_count": 0,
22        "verification": {
23            "verified": false,
24            "reason": "unsigned",
25            "signature": null,
26            "payload": null
27        }
28    },
29    "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
30    "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
31    "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
32    "author": {
33        "login": "octocat",
34        "id": 1,
35        "node_id": "MDQ6VXNlcjE=",
36        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
37        "gravatar_id": "",
38        "url": "https://api.github.com/users/octocat",
39        "html_url": "https://github.com/octocat",
40        "followers_url": "https://api.github.com/users/octocat/followers",
41        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
42        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
43        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
44        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
45        "organizations_url": "https://api.github.com/users/octocat/orgs",
46        "repos_url": "https://api.github.com/users/octocat/repos",
47        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
48        "received_events_url": "https://api.github.com/users/octocat/received_events",
49        "type": "User",
50        "site_admin": false
51    },
52    "committer": {
53        "login": "octocat",
54        "id": 1,
55        "node_id": "MDQ6VXNlcjE=",
56        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
57        "gravatar_id": "",
58        "url": "https://api.github.com/users/octocat",
59        "html_url": "https://github.com/octocat",
60        "followers_url": "https://api.github.com/users/octocat/followers",
61        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
62        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
63        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
64        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
65        "organizations_url": "https://api.github.com/users/octocat/orgs",
66        "repos_url": "https://api.github.com/users/octocat/repos",
67        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
68        "received_events_url": "https://api.github.com/users/octocat/received_events",
69        "type": "User",
70        "site_admin": false
71    },
72    "parents": [
73        {
74            "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
75            "url": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
76            "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
77        }
78    ],
79    "stats": {
80        "total": 2,
81        "additions": 1,
82        "deletions": 1
83    },
84    "files": [
85        {
86            "sha": "980a0d5f19a64b4b30a87d4206aade58726b60e3",
87            "filename": "file1.txt",
88            "status": "modified",
89            "additions": 1,
90            "deletions": 1,
91            "changes": 2,
92            "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
93            "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
94            "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
95            "patch": "@@ -29,7 +29,7 @@\n...\n-test\n+update test\n..."
96        }
97    ]
98}

Get deploy key
Copy

Retrieves information for a specified deploy key.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "key_id": 1234567
5}

Sample Output

1{
2    "id": 1234567,
3    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
4    "url": "https://api.github.com/repos/octocat/Hello-World/keys/1234567",
5    "title": "octocat@octomac",
6    "verified": true,
7    "created_at": "2014-12-10T15:53:42Z",
8    "read_only": true
9}

Get issue
Copy

Retrieves an issue of a GitHub repository by its number.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "issue_number": 1347
5}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
3    "repository_url": "https://api.github.com/repos/octocat/Hello-World",
4    "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
5    "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
6    "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
7    "html_url": "https://github.com/octocat/Hello-World/issues/1347",
8    "id": 123456,
9    "node_id": "MDU6SXNzdWUxMjM0NTY=",
10    "number": 1347,
11    "title": "Found a bug",
12    "user": {
13        "login": "octocat",
14        "id": 1,
15        "node_id": "MDQ6VXNlcjE=",
16        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
17        "gravatar_id": "",
18        "url": "https://api.github.com/users/octocat",
19        "html_url": "https://github.com/octocat",
20        "followers_url": "https://api.github.com/users/octocat/followers",
21        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
22        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
23        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
25        "organizations_url": "https://api.github.com/users/octocat/orgs",
26        "repos_url": "https://api.github.com/users/octocat/repos",
27        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
28        "received_events_url": "https://api.github.com/users/octocat/received_events",
29        "type": "User",
30        "site_admin": false
31    },
32    "labels": [
33        "bug"
34    ],
35    "state": "open",
36    "locked": false,
37    "assignee": "octocat",
38    "assignees": [
39        "octocat"
40    ],
41    "milestone": "v1.0",
42    "comments": 0,
43    "created_at": "2011-04-22T13:33:48Z",
44    "updated_at": "2011-04-22T13:33:48Z",
45    "closed_at": null,
46    "author_association": "OWNER",
47    "pull_request": {
48        "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
49        "html_url": "https://github.com/octocat/Hello-World/pull/1347",
50        "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
51        "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
52    },
53    "body": "I'm having a problem with this.",
54    "closed_by": null
55}

Get repository
Copy

Get details about a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World"
4}

Sample Output

1{
2    "id": 1296269,
3    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
4    "name": "Hello-World",
5    "full_name": "octocat/Hello-World",
6    "private": false,
7    "owner": {
8        "login": "octocat",
9        "id": 1,
10        "node_id": "MDQ6VXNlcjE=",
11        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
12        "gravatar_id": "",
13        "url": "https://api.github.com/users/octocat",
14        "html_url": "https://github.com/octocat",
15        "followers_url": "https://api.github.com/users/octocat/followers",
16        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
17        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
18        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
20        "organizations_url": "https://api.github.com/users/octocat/orgs",
21        "repos_url": "https://api.github.com/users/octocat/repos",
22        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
23        "received_events_url": "https://api.github.com/users/octocat/received_events",
24        "type": "User",
25        "site_admin": false
26    },
27    "html_url": "https://github.com/octocat/Hello-World",
28    "description": "This your first repo!",
29    "fork": false,
30    "url": "https://api.github.com/repos/octocat/Hello-World",
31    "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
32    "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
33    "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
34    "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
35    "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
36    "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
37    "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
38    "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
39    "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
40    "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
41    "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
42    "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
43    "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
44    "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
45    "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
46    "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
47    "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
48    "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
49    "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
50    "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
51    "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
52    "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
53    "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
54    "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
55    "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
56    "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
57    "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
58    "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
59    "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
60    "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
61    "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
62    "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
63    "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
64    "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
65    "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
66    "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
67    "created_at": "2011-01-26T19:01:12Z",
68    "updated_at": "2011-01-26T19:14:43Z",
69    "pushed_at": "2011-01-26T19:06:43Z",
70    "git_url": "git://github.com/octocat/Hello-World.git",
71    "ssh_url": "git@github.com:octocat/Hello-World.git",
72    "clone_url": "https://github.com/octocat/Hello-World.git",
73    "svn_url": "https://github.com/octocat/Hello-World",
74    "homepage": "https://github.com",
75    "size": 108,
76    "stargazers_count": 80,
77    "watchers_count": 80,
78    "language": "JavaScript",
79    "has_issues": true,
80    "has_projects": true,
81    "has_downloads": true,
82    "has_wiki": true,
83    "has_pages": false,
84    "forks_count": 9,
85    "mirror_url": null,
86    "archived": false,
87    "disabled": false,
88    "open_issues_count": 0,
89    "license": {
90        "key": "mit",
91        "name": "MIT License",
92        "spdx_id": "MIT",
93        "url": "https://api.github.com/licenses/mit",
94        "node_id": "MDc6TGljZW5zZTEz"
95    },
96    "forks": 9,
97    "open_issues": 0,
98    "watchers": 80,
99    "default_branch": "master",
100    "permissions": {
101        "admin": false,
102        "push": false,
103        "pull": true
104    },
105    "temp_clone_token": null,
106    "allow_squash_merge": true,
107    "allow_merge_commit": true,
108    "allow_rebase_merge": true,
109    "delete_branch_on_merge": false,
110    "network_count": 0,
111    "subscribers_count": 1
112}

Get team
Copy

Retrieves information for a team using the team‘s name.

Sample Input

1{
2    "organization": "acme-corp",
3    "team_slug": "engineering"
4}

Sample Output

1{
2    "name": "Engineering",
3    "id": 1234567,
4    "node_id": "MDQ6VGVhbTEyMzQ1Njc=",
5    "slug": "engineering",
6    "description": "ACME Corp Engineering Team",
7    "privacy": "closed",
8    "url": "https://api.github.com/organizations/9876543/team/1234567",
9    "html_url": "https://github.com/orgs/acme-corp/teams/engineering",
10    "members_url": "https://api.github.com/organizations/9876543/team/1234567/members{/member}",
11    "repositories_url": "https://api.github.com/organizations/9876543/team/1234567/repos",
12    "permission": "push",
13    "created_at": "2023-05-15T10:30:00Z",
14    "updated_at": "2023-05-20T14:45:30Z",
15    "members_count": 25,
16    "repos_count": 15,
17    "organization": {
18        "login": "acme-corp",
19        "id": 9876543,
20        "node_id": "MDEyOk9yZ2FuaXphdGlvbjk4NzY1NDM=",
21        "url": "https://api.github.com/orgs/acme-corp",
22        "repos_url": "https://api.github.com/orgs/acme-corp/repos",
23        "events_url": "https://api.github.com/orgs/acme-corp/events",
24        "hooks_url": "https://api.github.com/orgs/acme-corp/hooks",
25        "issues_url": "https://api.github.com/orgs/acme-corp/issues",
26        "members_url": "https://api.github.com/orgs/acme-corp/members{/member}",
27        "public_members_url": "https://api.github.com/orgs/acme-corp/public_members{/member}",
28        "avatar_url": "https://avatars.githubusercontent.com/u/9876543?v=4",
29        "description": "ACME Corporation - Innovative Solutions",
30        "is_verified": true,
31        "has_organization_projects": true,
32        "has_repository_projects": true,
33        "public_repos": 30,
34        "public_gists": 5,
35        "followers": 1000,
36        "following": 50,
37        "html_url": "https://github.com/acme-corp",
38        "created_at": "2020-01-01T00:00:00Z",
39        "updated_at": "2023-05-20T14:45:30Z",
40        "type": "Organization"
41    },
42    "parent": null
43}

Get the latest published release
Copy

Retrieves the latest published release of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World"
4}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
3    "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
4    "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
5    "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
6    "id": 1,
7    "node_id": "MDc6UmVsZWFzZTE=",
8    "tag_name": "v1.0.0",
9    "target_commitish": "master",
10    "name": "v1.0.0",
11    "draft": false,
12    "author": {
13        "login": "octocat",
14        "id": 1,
15        "node_id": "MDQ6VXNlcjE=",
16        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
17        "gravatar_id": "",
18        "url": "https://api.github.com/users/octocat",
19        "html_url": "https://github.com/octocat",
20        "followers_url": "https://api.github.com/users/octocat/followers",
21        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
22        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
23        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
25        "organizations_url": "https://api.github.com/users/octocat/orgs",
26        "repos_url": "https://api.github.com/users/octocat/repos",
27        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
28        "received_events_url": "https://api.github.com/users/octocat/received_events",
29        "type": "User",
30        "site_admin": false
31    },
32    "prerelease": false,
33    "created_at": "2013-02-27T19:35:32Z",
34    "published_at": "2013-02-27T19:35:32Z",
35    "assets": [],
36    "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
37    "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
38    "body": "Description of the release"
39}

Get user
Copy

Retrieves information on a specified user.

Sample Input

1{
2    "username": "octocat"
3}

Sample Output

1{
2    "login": "octocat",
3    "id": 583231,
4    "node_id": "MDQ6VXNlcjU4MzIzMQ==",
5    "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
6    "gravatar_id": "",
7    "url": "https://api.github.com/users/octocat",
8    "html_url": "https://github.com/octocat",
9    "followers_url": "https://api.github.com/users/octocat/followers",
10    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
11    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
12    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
13    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
14    "organizations_url": "https://api.github.com/users/octocat/orgs",
15    "repos_url": "https://api.github.com/users/octocat/repos",
16    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
17    "received_events_url": "https://api.github.com/users/octocat/received_events",
18    "type": "User",
19    "site_admin": false,
20    "name": "The Octocat",
21    "company": "@github",
22    "blog": "https://github.blog",
23    "location": "San Francisco",
24    "email": null,
25    "hireable": null,
26    "bio": "I'm the GitHub mascot!",
27    "public_repos": 8,
28    "public_gists": 8,
29    "followers": 6958,
30    "following": 9,
31    "created_at": "2011-01-25T18:44:36Z",
32    "updated_at": "2023-05-22T14:15:37Z"
33}

List branches
Copy

Lists the branches of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "protected": false,
5    "page": 1,
6    "per_page": 30
7}

Sample Output

1{
2    "results": [
3        {
4            "name": "main",
5            "commit": {
6                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
7                "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
8            },
9            "protected": true
10        },
11        {
12            "name": "feature-branch",
13            "commit": {
14                "sha": "f45ad9d5b57875f334f61aebed695e2e4193db5e",
15                "url": "https://api.github.com/repos/octocat/Hello-World/commits/f45ad9d5b57875f334f61aebed695e2e4193db5e"
16            },
17            "protected": false
18        }
19    ],
20    "metadata": {
21        "first_page": 1,
22        "last_page": 2,
23        "next_page": 2,
24        "prev_page": null
25    }
26}

List collaborators
Copy

Lists all collaborators for the specified repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "affiliation": "all",
5    "page": 1,
6    "per_page": 30
7}

Sample Output

1{
2    "results": [
3        {
4            "login": "octocat",
5            "id": 1,
6            "node_id": "MDQ6VXNlcjE=",
7            "avatar_url": "https://github.com/images/error/octocat_happy.gif",
8            "gravatar_id": "",
9            "url": "https://api.github.com/users/octocat",
10            "html_url": "https://github.com/octocat",
11            "followers_url": "https://api.github.com/users/octocat/followers",
12            "following_url": "https://api.github.com/users/octocat/following{/other_user}",
13            "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
14            "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
15            "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
16            "organizations_url": "https://api.github.com/users/octocat/orgs",
17            "repos_url": "https://api.github.com/users/octocat/repos",
18            "events_url": "https://api.github.com/users/octocat/events{/privacy}",
19            "received_events_url": "https://api.github.com/users/octocat/received_events",
20            "type": "User",
21            "site_admin": false,
22            "permissions": {
23                "admin": true,
24                "push": true,
25                "pull": true
26            }
27        },
28        {
29            "login": "hubot",
30            "id": 2,
31            "node_id": "MDQ6VXNlcjI=",
32            "avatar_url": "https://github.com/images/error/hubot_happy.gif",
33            "gravatar_id": "",
34            "url": "https://api.github.com/users/hubot",
35            "html_url": "https://github.com/hubot",
36            "followers_url": "https://api.github.com/users/hubot/followers",
37            "following_url": "https://api.github.com/users/hubot/following{/other_user}",
38            "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
39            "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
40            "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
41            "organizations_url": "https://api.github.com/users/hubot/orgs",
42            "repos_url": "https://api.github.com/users/hubot/repos",
43            "events_url": "https://api.github.com/users/hubot/events{/privacy}",
44            "received_events_url": "https://api.github.com/users/hubot/received_events",
45            "type": "User",
46            "site_admin": false,
47            "permissions": {
48                "admin": false,
49                "push": true,
50                "pull": true
51            }
52        }
53    ],
54    "metadata": {
55        "first_page": 1,
56        "last_page": 2,
57        "next_page": 2,
58        "prev_page": null
59    }
60}

List deploy keys
Copy

Lists the deploy keys for a specified repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World"
4}

Sample Output

1{
2    "results": [
3        {
4            "id": 1,
5            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
6            "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
7            "title": "octocat@octomac",
8            "verified": true,
9            "created_at": "2014-12-10T15:53:42Z",
10            "read_only": true
11        },
12        {
13            "id": 2,
14            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
15            "url": "https://api.github.com/repos/octocat/Hello-World/keys/2",
16            "title": "deploy-key-2",
17            "verified": true,
18            "created_at": "2014-12-10T15:53:42Z",
19            "read_only": false
20        }
21    ]
22}

List languages
Copy

Lists the languages of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World"
4}

Sample Output

1{
2    "JavaScript": 3541,
3    "Python": 2856,
4    "HTML": 1204,
5    "CSS": 876,
6    "Ruby": 540
7}

List matching references
Copy

Lists matching GitHub references.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "reference": "heads/main"
5}

Sample Output

1{
2    "results": [
3        {
4            "ref": "refs/heads/main",
5            "node_id": "MDM6UmVmcmVmczpoZWFkcy9tYWlu",
6            "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/main",
7            "object": {
8                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
9                "type": "commit",
10                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
11            }
12        }
13    ],
14    "metadata": {
15        "first_page": 1,
16        "last_page": 1,
17        "next_page": null,
18        "prev_page": null
19    }
20}

List organization members
Copy

Lists members of an organization.

Sample Input

1{
2    "organization": "acme-corp",
3    "filter": "all",
4    "role": "all",
5    "page": 1,
6    "per_page": 100
7}

Sample Output

1{
2    "results": [
3        {
4            "login": "johndoe",
5            "id": 12345,
6            "node_id": "MDQ6VXNlcjEyMzQ1",
7            "avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4",
8            "gravatar_id": "",
9            "url": "https://api.github.com/users/johndoe",
10            "html_url": "https://github.com/johndoe",
11            "followers_url": "https://api.github.com/users/johndoe/followers",
12            "following_url": "https://api.github.com/users/johndoe/following{/other_user}",
13            "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}",
14            "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}",
15            "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions",
16            "organizations_url": "https://api.github.com/users/johndoe/orgs",
17            "repos_url": "https://api.github.com/users/johndoe/repos",
18            "events_url": "https://api.github.com/users/johndoe/events{/privacy}",
19            "received_events_url": "https://api.github.com/users/johndoe/received_events",
20            "type": "User",
21            "site_admin": false
22        },
23        {
24            "login": "janedoe",
25            "id": 67890,
26            "node_id": "MDQ6VXNlcjY3ODkw",
27            "avatar_url": "https://avatars.githubusercontent.com/u/67890?v=4",
28            "gravatar_id": "",
29            "url": "https://api.github.com/users/janedoe",
30            "html_url": "https://github.com/janedoe",
31            "followers_url": "https://api.github.com/users/janedoe/followers",
32            "following_url": "https://api.github.com/users/janedoe/following{/other_user}",
33            "gists_url": "https://api.github.com/users/janedoe/gists{/gist_id}",
34            "starred_url": "https://api.github.com/users/janedoe/starred{/owner}{/repo}",
35            "subscriptions_url": "https://api.github.com/users/janedoe/subscriptions",
36            "organizations_url": "https://api.github.com/users/janedoe/orgs",
37            "repos_url": "https://api.github.com/users/janedoe/repos",
38            "events_url": "https://api.github.com/users/janedoe/events{/privacy}",
39            "received_events_url": "https://api.github.com/users/janedoe/received_events",
40            "type": "User",
41            "site_admin": true
42        }
43    ],
44    "metadata": {
45        "first_page": 1,
46        "last_page": 3,
47        "next_page": 2,
48        "prev_page": null
49    }
50}

List organization repositories
Copy

List an organization's GitHub repositories.

Sample Input

1{
2    "organization": "trayio",
3    "sort": "updated",
4    "direction": "desc",
5    "type": "all",
6    "page": 1,
7    "per_page": 2
8}

Sample Output

1{
2    "results": [
3        {
4            "id": 123456789,
5            "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
6            "name": "connector-docs",
7            "full_name": "trayio/connector-docs",
8            "private": false,
9            "owner": {
10                "login": "trayio",
11                "id": 87654321,
12                "node_id": "MDEyOk9yZ2FuaXphdGlvbjg3NjU0MzIx",
13                "avatar_url": "https://avatars.githubusercontent.com/u/87654321?v=4",
14                "gravatar_id": "",
15                "url": "https://api.github.com/users/trayio",
16                "html_url": "https://github.com/trayio",
17                "followers_url": "https://api.github.com/users/trayio/followers",
18                "following_url": "https://api.github.com/users/trayio/following{/other_user}",
19                "gists_url": "https://api.github.com/users/trayio/gists{/gist_id}",
20                "starred_url": "https://api.github.com/users/trayio/starred{/owner}{/repo}",
21                "subscriptions_url": "https://api.github.com/users/trayio/subscriptions",
22                "organizations_url": "https://api.github.com/users/trayio/orgs",
23                "repos_url": "https://api.github.com/users/trayio/repos",
24                "events_url": "https://api.github.com/users/trayio/events{/privacy}",
25                "received_events_url": "https://api.github.com/users/trayio/received_events",
26                "type": "Organization",
27                "site_admin": false
28            },
29            "html_url": "https://github.com/trayio/connector-docs",
30            "description": "Documentation for Tray.io connectors",
31            "fork": false,
32            "url": "https://api.github.com/repos/trayio/connector-docs",
33            "created_at": "2023-05-15T10:30:00Z",
34            "updated_at": "2023-05-20T14:45:30Z",
35            "pushed_at": "2023-05-20T14:45:30Z",
36            "git_url": "git://github.com/trayio/connector-docs.git",
37            "ssh_url": "git@github.com:trayio/connector-docs.git",
38            "clone_url": "https://github.com/trayio/connector-docs.git",
39            "svn_url": "https://github.com/trayio/connector-docs",
40            "homepage": "https://tray.io",
41            "size": 1024,
42            "stargazers_count": 50,
43            "watchers_count": 50,
44            "language": "Markdown",
45            "has_issues": true,
46            "has_projects": true,
47            "has_downloads": true,
48            "has_wiki": true,
49            "has_pages": false,
50            "forks_count": 10,
51            "archived": false,
52            "disabled": false,
53            "open_issues_count": 5,
54            "license": {
55                "key": "mit",
56                "name": "MIT License",
57                "spdx_id": "MIT",
58                "url": "https://api.github.com/licenses/mit",
59                "node_id": "MDc6TGljZW5zZTEz"
60            },
61            "forks": 10,
62            "open_issues": 5,
63            "watchers": 50,
64            "default_branch": "main",
65            "permissions": {
66                "admin": false,
67                "push": false,
68                "pull": true
69            }
70        },
71        {
72            "id": 987654321,
73            "node_id": "MDEwOlJlcG9zaXRvcnk5ODc2NTQzMjE=",
74            "name": "tray-cli",
75            "full_name": "trayio/tray-cli",
76            "private": false,
77            "owner": {
78                "login": "trayio",
79                "id": 87654321,
80                "node_id": "MDEyOk9yZ2FuaXphdGlvbjg3NjU0MzIx",
81                "avatar_url": "https://avatars.githubusercontent.com/u/87654321?v=4",
82                "gravatar_id": "",
83                "url": "https://api.github.com/users/trayio",
84                "html_url": "https://github.com/trayio",
85                "followers_url": "https://api.github.com/users/trayio/followers",
86                "following_url": "https://api.github.com/users/trayio/following{/other_user}",
87                "gists_url": "https://api.github.com/users/trayio/gists{/gist_id}",
88                "starred_url": "https://api.github.com/users/trayio/starred{/owner}{/repo}",
89                "subscriptions_url": "https://api.github.com/users/trayio/subscriptions",
90                "organizations_url": "https://api.github.com/users/trayio/orgs",
91                "repos_url": "https://api.github.com/users/trayio/repos",
92                "events_url": "https://api.github.com/users/trayio/events{/privacy}",
93                "received_events_url": "https://api.github.com/users/trayio/received_events",
94                "type": "Organization",
95                "site_admin": false
96            },
97            "html_url": "https://github.com/trayio/tray-cli",
98            "description": "Command-line interface for Tray.io",
99            "fork": false,
100            "url": "https://api.github.com/repos/trayio/tray-cli",
101            "created_at": "2023-04-01T09:00:00Z",
102            "updated_at": "2023-05-19T16:30:45Z",
103            "pushed_at": "2023-05-19T16:30:45Z",
104            "git_url": "git://github.com/trayio/tray-cli.git",
105            "ssh_url": "git@github.com:trayio/tray-cli.git",
106            "clone_url": "https://github.com/trayio/tray-cli.git",
107            "svn_url": "https://github.com/trayio/tray-cli",
108            "homepage": "https://tray.io",
109            "size": 512,
110            "stargazers_count": 25,
111            "watchers_count": 25,
112            "language": "JavaScript",
113            "has_issues": true,
114            "has_projects": true,
115            "has_downloads": true,
116            "has_wiki": false,
117            "has_pages": false,
118            "forks_count": 5,
119            "archived": false,
120            "disabled": false,
121            "open_issues_count": 2,
122            "license": {
123                "key": "apache-2.0",
124                "name": "Apache License 2.0",
125                "spdx_id": "Apache-2.0",
126                "url": "https://api.github.com/licenses/apache-2.0",
127                "node_id": "MDc6TGljZW5zZTI="
128            },
129            "forks": 5,
130            "open_issues": 2,
131            "watchers": 25,
132            "default_branch": "main",
133            "permissions": {
134                "admin": false,
135                "push": false,
136                "pull": true
137            }
138        }
139    ],
140    "metadata": {
141        "first_page": 1,
142        "last_page": 5,
143        "next_page": 2,
144        "prev_page": null
145    }
146}

List organization teams
Copy

Lists all teams in an organization that are visible to the authenticated user.

Sample Input

1{
2    "organization": "acme-corp",
3    "page": 1,
4    "per_page": 30
5}

Sample Output

1{
2    "results": [
3        {
4            "name": "Engineering",
5            "id": 1234567,
6            "node_id": "MDQ6VGVhbTEyMzQ1Njc=",
7            "slug": "engineering",
8            "description": "ACME Corp Engineering Team",
9            "privacy": "closed",
10            "url": "https://api.github.com/teams/1234567",
11            "html_url": "https://github.com/orgs/acme-corp/teams/engineering",
12            "members_url": "https://api.github.com/teams/1234567/members{/member}",
13            "repositories_url": "https://api.github.com/teams/1234567/repos",
14            "permission": "pull",
15            "parent": null
16        },
17        {
18            "name": "Marketing",
19            "id": 2345678,
20            "node_id": "MDQ6VGVhbTIzNDU2Nzg=",
21            "slug": "marketing",
22            "description": "ACME Corp Marketing Team",
23            "privacy": "secret",
24            "url": "https://api.github.com/teams/2345678",
25            "html_url": "https://github.com/orgs/acme-corp/teams/marketing",
26            "members_url": "https://api.github.com/teams/2345678/members{/member}",
27            "repositories_url": "https://api.github.com/teams/2345678/repos",
28            "permission": "pull",
29            "parent": null
30        }
31    ],
32    "metadata": {
33        "first_page": 1,
34        "last_page": 2,
35        "next_page": 2,
36        "prev_page": null
37    }
38}

List repository commits
Copy

List the commits of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "page": 1,
5    "per_page": 30,
6    "sha": "main",
7    "path": "README.md",
8    "author": "octocat@github.com",
9    "since": "2023-01-01T00:00:00Z",
10    "until": "2023-06-30T23:59:59Z"
11}

Sample Output

1{
2    "results": [
3        {
4            "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
5            "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
6            "commit": {
7                "author": {
8                    "name": "Monalisa Octocat",
9                    "email": "octocat@github.com",
10                    "date": "2023-06-15T23:45:32Z"
11                },
12                "committer": {
13                    "name": "GitHub",
14                    "email": "noreply@github.com",
15                    "date": "2023-06-15T23:45:32Z"
16                },
17                "message": "Update README.md",
18                "tree": {
19                    "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
20                    "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312"
21                },
22                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
23                "comment_count": 0,
24                "verification": {
25                    "verified": true,
26                    "reason": "valid",
27                    "signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJa+rDICRBK7hj4Ov3rIwAAdHIIAGSZr9M+t7...",
28                    "payload": "tree 9fb037999f264ba9a7fc6274d15fa3ae2ab98312\nparent 7d1b31e74ee336d15cbd21741bc88a537ed063a0\nauthor Monalisa Octocat <octocat@github.com> 1529107532 -0700\ncommitter GitHub <noreply@github.com> 1529107532 -0700\n\nUpdate README.md"
29                }
30            },
31            "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
32            "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
33            "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
34            "author": {
35                "login": "octocat",
36                "id": 1,
37                "node_id": "MDQ6VXNlcjE=",
38                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
39                "gravatar_id": "",
40                "url": "https://api.github.com/users/octocat",
41                "html_url": "https://github.com/octocat",
42                "followers_url": "https://api.github.com/users/octocat/followers",
43                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
44                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
45                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
46                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
47                "organizations_url": "https://api.github.com/users/octocat/orgs",
48                "repos_url": "https://api.github.com/users/octocat/repos",
49                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
50                "received_events_url": "https://api.github.com/users/octocat/received_events",
51                "type": "User",
52                "site_admin": false
53            },
54            "committer": {
55                "login": "web-flow",
56                "id": 19864447,
57                "node_id": "MDQ6VXNlcjE5ODY0NDQ3",
58                "avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4",
59                "gravatar_id": "",
60                "url": "https://api.github.com/users/web-flow",
61                "html_url": "https://github.com/web-flow",
62                "followers_url": "https://api.github.com/users/web-flow/followers",
63                "following_url": "https://api.github.com/users/web-flow/following{/other_user}",
64                "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
65                "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
66                "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
67                "organizations_url": "https://api.github.com/users/web-flow/orgs",
68                "repos_url": "https://api.github.com/users/web-flow/repos",
69                "events_url": "https://api.github.com/users/web-flow/events{/privacy}",
70                "received_events_url": "https://api.github.com/users/web-flow/received_events",
71                "type": "User",
72                "site_admin": false
73            },
74            "parents": [
75                {
76                    "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0",
77                    "url": "https://api.github.com/repos/octocat/Hello-World/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0",
78                    "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0"
79                }
80            ]
81        }
82    ],
83    "metadata": {
84        "first_page": 1,
85        "last_page": 3,
86        "next_page": 2,
87        "prev_page": null
88    }
89}

List repository contributors
Copy

List all of the contributors to a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "show_anonymous_contributors": false,
5    "page": 1,
6    "per_page": 30
7}

Sample Output

1{
2    "results": [
3        {
4            "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
5            "node_id": "MDQ6VXNlcjE=",
6            "commit": {
7                "author": {
8                    "name": "Monalisa Octocat",
9                    "email": "octocat@github.com",
10                    "date": "2023-05-15T14:30:00Z"
11                },
12                "committer": {
13                    "name": "GitHub",
14                    "email": "noreply@github.com",
15                    "date": "2023-05-15T14:30:00Z"
16                },
17                "message": "Fix typo in README",
18                "tree": {
19                    "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
20                    "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
21                },
22                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
23                "comment_count": 0,
24                "verification": {
25                    "verified": true,
26                    "reason": "valid",
27                    "signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----",
28                    "payload": "tree b4eecafa9be2f2006ce1b709d6857b07069b4608\nparent 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\nauthor Monalisa Octocat <octocat@github.com> 1684160600 +0000\ncommitter GitHub <noreply@github.com> 1684160600 +0000\n\nFix typo in README"
29                }
30            },
31            "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
32            "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
33            "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
34            "author": {
35                "login": "octocat",
36                "id": 1,
37                "node_id": "MDQ6VXNlcjE=",
38                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
39                "gravatar_id": "",
40                "url": "https://api.github.com/users/octocat",
41                "html_url": "https://github.com/octocat",
42                "followers_url": "https://api.github.com/users/octocat/followers",
43                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
44                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
45                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
46                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
47                "organizations_url": "https://api.github.com/users/octocat/orgs",
48                "repos_url": "https://api.github.com/users/octocat/repos",
49                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
50                "received_events_url": "https://api.github.com/users/octocat/received_events",
51                "type": "User",
52                "site_admin": false
53            },
54            "committer": {
55                "login": "web-flow",
56                "id": 19864447,
57                "node_id": "MDQ6VXNlcjE5ODY0NDQ3",
58                "avatar_url": "https://avatars.githubusercontent.com/u/19864447?v=4",
59                "gravatar_id": "",
60                "url": "https://api.github.com/users/web-flow",
61                "html_url": "https://github.com/web-flow",
62                "followers_url": "https://api.github.com/users/web-flow/followers",
63                "following_url": "https://api.github.com/users/web-flow/following{/other_user}",
64                "gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
65                "starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
66                "subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
67                "organizations_url": "https://api.github.com/users/web-flow/orgs",
68                "repos_url": "https://api.github.com/users/web-flow/repos",
69                "events_url": "https://api.github.com/users/web-flow/events{/privacy}",
70                "received_events_url": "https://api.github.com/users/web-flow/received_events",
71                "type": "User",
72                "site_admin": false
73            },
74            "parents": [
75                {
76                    "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
77                    "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
78                    "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
79                }
80            ]
81        }
82    ],
83    "metadata": {
84        "first_page": 1,
85        "last_page": 2,
86        "next_page": 2,
87        "prev_page": null
88    }
89}

List repository forks
Copy

List all of the forks of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "sort": "newest",
5    "page": 1,
6    "per_page": 30
7}

Sample Output

1{
2    "results": [
3        {
4            "id": 1296269,
5            "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
6            "name": "Hello-World-Fork",
7            "full_name": "octocat-fork/Hello-World-Fork",
8            "private": false,
9            "owner": {
10                "login": "octocat-fork",
11                "id": 1,
12                "node_id": "MDQ6VXNlcjE=",
13                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
14                "gravatar_id": "",
15                "url": "https://api.github.com/users/octocat-fork",
16                "html_url": "https://github.com/octocat-fork",
17                "followers_url": "https://api.github.com/users/octocat-fork/followers",
18                "following_url": "https://api.github.com/users/octocat-fork/following{/other_user}",
19                "gists_url": "https://api.github.com/users/octocat-fork/gists{/gist_id}",
20                "starred_url": "https://api.github.com/users/octocat-fork/starred{/owner}{/repo}",
21                "subscriptions_url": "https://api.github.com/users/octocat-fork/subscriptions",
22                "organizations_url": "https://api.github.com/users/octocat-fork/orgs",
23                "repos_url": "https://api.github.com/users/octocat-fork/repos",
24                "events_url": "https://api.github.com/users/octocat-fork/events{/privacy}",
25                "received_events_url": "https://api.github.com/users/octocat-fork/received_events",
26                "type": "User",
27                "site_admin": false
28            },
29            "html_url": "https://github.com/octocat-fork/Hello-World-Fork",
30            "description": "This is your first repo!",
31            "fork": true,
32            "url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork",
33            "forks_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/forks",
34            "keys_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/keys{/key_id}",
35            "collaborators_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/collaborators{/collaborator}",
36            "teams_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/teams",
37            "hooks_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/hooks",
38            "issue_events_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues/events{/number}",
39            "events_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/events",
40            "assignees_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/assignees{/user}",
41            "branches_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/branches{/branch}",
42            "tags_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/tags",
43            "blobs_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/blobs{/sha}",
44            "git_tags_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/tags{/sha}",
45            "git_refs_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/refs{/sha}",
46            "trees_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/trees{/sha}",
47            "statuses_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/statuses/{sha}",
48            "languages_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/languages",
49            "stargazers_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/stargazers",
50            "contributors_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/contributors",
51            "subscribers_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/subscribers",
52            "subscription_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/subscription",
53            "commits_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/commits{/sha}",
54            "git_commits_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/commits{/sha}",
55            "comments_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/comments{/number}",
56            "issue_comment_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues/comments{/number}",
57            "contents_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/contents/{+path}",
58            "compare_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/compare/{base}...{head}",
59            "merges_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/merges",
60            "archive_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/{archive_format}{/ref}",
61            "downloads_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/downloads",
62            "issues_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues{/number}",
63            "pulls_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/pulls{/number}",
64            "milestones_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/milestones{/number}",
65            "notifications_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/notifications{?since,all,participating}",
66            "labels_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/labels{/name}",
67            "releases_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/releases{/id}",
68            "deployments_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/deployments",
69            "created_at": "2020-01-20T22:42:08Z",
70            "updated_at": "2020-01-20T22:42:08Z",
71            "pushed_at": "2020-01-20T22:42:08Z",
72            "git_url": "git://github.com/octocat-fork/Hello-World-Fork.git",
73            "ssh_url": "git@github.com:octocat-fork/Hello-World-Fork.git",
74            "clone_url": "https://github.com/octocat-fork/Hello-World-Fork.git",
75            "svn_url": "https://github.com/octocat-fork/Hello-World-Fork",
76            "homepage": "https://github.com",
77            "size": 108,
78            "stargazers_count": 80,
79            "watchers_count": 80,
80            "language": "JavaScript",
81            "has_issues": true,
82            "has_projects": true,
83            "has_downloads": true,
84            "has_wiki": true,
85            "has_pages": false,
86            "forks_count": 9,
87            "mirror_url": null,
88            "archived": false,
89            "disabled": false,
90            "open_issues_count": 7,
91            "license": "MIT",
92            "forks": 9,
93            "open_issues": 7,
94            "watchers": 80,
95            "default_branch": "master",
96            "permissions": {
97                "admin": false,
98                "push": false,
99                "pull": true
100            }
101        }
102    ],
103    "metadata": {
104        "first_page": 1,
105        "last_page": 3,
106        "next_page": 2,
107        "prev_page": null
108    }
109}

List repository issues
Copy

Lists issues of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "state": "open",
5    "labels": [
6        "bug",
7        "enhancement"
8    ],
9    "sort": "created",
10    "direction": "desc",
11    "since": "2023-01-01T00:00:00Z",
12    "page": 1,
13    "per_page": 30
14}

Sample Output

1{
2    "results": [
3        {
4            "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
5            "repository_url": "https://api.github.com/repos/octocat/Hello-World",
6            "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
7            "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
8            "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
9            "html_url": "https://github.com/octocat/Hello-World/issues/1347",
10            "id": 123456789,
11            "node_id": "MDU6SXNzdWUxMjM0NTY3ODk=",
12            "number": 1347,
13            "title": "Found a bug in the login process",
14            "user": {
15                "login": "octocat",
16                "id": 1,
17                "node_id": "MDQ6VXNlcjE=",
18                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
19                "gravatar_id": "",
20                "url": "https://api.github.com/users/octocat",
21                "html_url": "https://github.com/octocat",
22                "followers_url": "https://api.github.com/users/octocat/followers",
23                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
24                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
25                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
26                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
27                "organizations_url": "https://api.github.com/users/octocat/orgs",
28                "repos_url": "https://api.github.com/users/octocat/repos",
29                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
30                "received_events_url": "https://api.github.com/users/octocat/received_events",
31                "type": "User",
32                "site_admin": false
33            },
34            "labels": [
35                {
36                    "id": 208045946,
37                    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
38                    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
39                    "name": "bug",
40                    "color": "d73a4a",
41                    "default": true,
42                    "description": "Something isn't working"
43                },
44                {
45                    "id": 208045947,
46                    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
47                    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
48                    "name": "enhancement",
49                    "color": "a2eeef",
50                    "default": false,
51                    "description": "New feature or request"
52                }
53            ],
54            "state": "open",
55            "locked": false,
56            "assignee": {
57                "login": "octocat",
58                "id": 1,
59                "node_id": "MDQ6VXNlcjE=",
60                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
61                "gravatar_id": "",
62                "url": "https://api.github.com/users/octocat",
63                "html_url": "https://github.com/octocat",
64                "followers_url": "https://api.github.com/users/octocat/followers",
65                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
66                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
67                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
68                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
69                "organizations_url": "https://api.github.com/users/octocat/orgs",
70                "repos_url": "https://api.github.com/users/octocat/repos",
71                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
72                "received_events_url": "https://api.github.com/users/octocat/received_events",
73                "type": "User",
74                "site_admin": false
75            },
76            "assignees": [
77                {
78                    "login": "octocat",
79                    "id": 1,
80                    "node_id": "MDQ6VXNlcjE=",
81                    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
82                    "gravatar_id": "",
83                    "url": "https://api.github.com/users/octocat",
84                    "html_url": "https://github.com/octocat",
85                    "followers_url": "https://api.github.com/users/octocat/followers",
86                    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
87                    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
88                    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
89                    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
90                    "organizations_url": "https://api.github.com/users/octocat/orgs",
91                    "repos_url": "https://api.github.com/users/octocat/repos",
92                    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
93                    "received_events_url": "https://api.github.com/users/octocat/received_events",
94                    "type": "User",
95                    "site_admin": false
96                }
97            ],
98            "milestone": {
99                "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
100                "html_url": "https://github.com/octocat/Hello-World/milestone/1",
101                "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
102                "id": 1002604,
103                "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
104                "number": 1,
105                "title": "v1.0",
106                "description": "Tracking milestone for version 1.0",
107                "creator": {
108                    "login": "octocat",
109                    "id": 1,
110                    "node_id": "MDQ6VXNlcjE=",
111                    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
112                    "gravatar_id": "",
113                    "url": "https://api.github.com/users/octocat",
114                    "html_url": "https://github.com/octocat",
115                    "followers_url": "https://api.github.com/users/octocat/followers",
116                    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
117                    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
118                    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
119                    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
120                    "organizations_url": "https://api.github.com/users/octocat/orgs",
121                    "repos_url": "https://api.github.com/users/octocat/repos",
122                    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
123                    "received_events_url": "https://api.github.com/users/octocat/received_events",
124                    "type": "User",
125                    "site_admin": false
126                },
127                "open_issues": 4,
128                "closed_issues": 8,
129                "state": "open",
130                "created_at": "2023-01-01T00:00:00Z",
131                "updated_at": "2023-03-01T00:00:00Z",
132                "due_on": "2023-04-01T00:00:00Z",
133                "closed_at": null
134            },
135            "comments": 0,
136            "created_at": "2023-01-01T00:00:00Z",
137            "updated_at": "2023-03-01T00:00:00Z",
138            "closed_at": null,
139            "author_association": "OWNER",
140            "body": "I'm having trouble logging in to the application. The login button doesn't seem to be working."
141        }
142    ],
143    "metadata": {
144        "first_page": 1,
145        "last_page": 5,
146        "next_page": 2,
147        "prev_page": null
148    }
149}

List repository teams
Copy

Lists the teams of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "page": 1,
5    "per_page": 30
6}

Sample Output

1{
2    "results": [
3        {
4            "name": "Developers",
5            "id": 1,
6            "node_id": "MDQ6VGVhbTE=",
7            "slug": "developers",
8            "description": "Core development team",
9            "privacy": "closed",
10            "url": "https://api.github.com/teams/1",
11            "html_url": "https://github.com/orgs/octocat/teams/developers",
12            "members_url": "https://api.github.com/teams/1/members{/member}",
13            "repositories_url": "https://api.github.com/teams/1/repos",
14            "permission": "push",
15            "parent": null
16        },
17        {
18            "name": "Reviewers",
19            "id": 2,
20            "node_id": "MDQ6VGVhbTI=",
21            "slug": "reviewers",
22            "description": "Code review team",
23            "privacy": "closed",
24            "url": "https://api.github.com/teams/2",
25            "html_url": "https://github.com/orgs/octocat/teams/reviewers",
26            "members_url": "https://api.github.com/teams/2/members{/member}",
27            "repositories_url": "https://api.github.com/teams/2/repos",
28            "permission": "pull",
29            "parent": null
30        }
31    ],
32    "metadata": {
33        "first_page": 1,
34        "last_page": 1,
35        "next_page": null,
36        "prev_page": null
37    }
38}

Lists the tags of a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "page": 1,
5    "per_page": 30
6}

Sample Output

1{
2    "results": [
3        {
4            "name": "v1.0.0",
5            "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
6            "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
7            "commit": {
8                "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
9                "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
10            },
11            "node_id": "MDM6UmVmcmVmczp0YWdzL3YxLjAuMA=="
12        },
13        {
14            "name": "v0.9.0",
15            "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v0.9.0",
16            "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v0.9.0",
17            "commit": {
18                "sha": "f3e87f0cecb4f3af0f4c1d14fd6d11096d3e8740",
19                "url": "https://api.github.com/repos/octocat/Hello-World/commits/f3e87f0cecb4f3af0f4c1d14fd6d11096d3e8740"
20            },
21            "node_id": "MDM6UmVmcmVmczp0YWdzL3YwLjkuMA=="
22        }
23    ],
24    "metadata": {
25        "first_page": 1,
26        "last_page": 2,
27        "next_page": 2,
28        "prev_page": null
29    }
30}

List team members
Copy

Lists members of a team.

Sample Input

1{
2    "organization": "acme-corp",
3    "team_slug": "developers",
4    "role": "all",
5    "page": 1,
6    "per_page": 100
7}

Sample Output

1{
2    "results": [
3        {
4            "login": "johndoe",
5            "id": 12345,
6            "node_id": "MDQ6VXNlcjEyMzQ1",
7            "avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4",
8            "gravatar_id": "",
9            "url": "https://api.github.com/users/johndoe",
10            "html_url": "https://github.com/johndoe",
11            "followers_url": "https://api.github.com/users/johndoe/followers",
12            "following_url": "https://api.github.com/users/johndoe/following{/other_user}",
13            "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}",
14            "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}",
15            "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions",
16            "organizations_url": "https://api.github.com/users/johndoe/orgs",
17            "repos_url": "https://api.github.com/users/johndoe/repos",
18            "events_url": "https://api.github.com/users/johndoe/events{/privacy}",
19            "received_events_url": "https://api.github.com/users/johndoe/received_events",
20            "type": "User",
21            "site_admin": false
22        },
23        {
24            "login": "janedoe",
25            "id": 67890,
26            "node_id": "MDQ6VXNlcjY3ODkw",
27            "avatar_url": "https://avatars.githubusercontent.com/u/67890?v=4",
28            "gravatar_id": "",
29            "url": "https://api.github.com/users/janedoe",
30            "html_url": "https://github.com/janedoe",
31            "followers_url": "https://api.github.com/users/janedoe/followers",
32            "following_url": "https://api.github.com/users/janedoe/following{/other_user}",
33            "gists_url": "https://api.github.com/users/janedoe/gists{/gist_id}",
34            "starred_url": "https://api.github.com/users/janedoe/starred{/owner}{/repo}",
35            "subscriptions_url": "https://api.github.com/users/janedoe/subscriptions",
36            "organizations_url": "https://api.github.com/users/janedoe/orgs",
37            "repos_url": "https://api.github.com/users/janedoe/repos",
38            "events_url": "https://api.github.com/users/janedoe/events{/privacy}",
39            "received_events_url": "https://api.github.com/users/janedoe/received_events",
40            "type": "User",
41            "site_admin": false
42        }
43    ],
44    "metadata": {
45        "first_page": 1,
46        "last_page": 1,
47        "next_page": null,
48        "prev_page": null
49    }
50}

List user repositories
Copy

Lists a user GitHub repositories.

Sample Input

1{
2    "owner": "octocat",
3    "type": "owner",
4    "sort": "updated",
5    "direction": "desc",
6    "page": 1,
7    "per_page": 30
8}

Sample Output

1{
2    "results": [
3        {
4            "id": 123456789,
5            "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
6            "name": "Hello-World",
7            "full_name": "octocat/Hello-World",
8            "private": false,
9            "owner": {
10                "login": "octocat",
11                "id": 1234567,
12                "node_id": "MDQ6VXNlcjEyMzQ1Njc=",
13                "avatar_url": "https://avatars.githubusercontent.com/u/1234567?v=4",
14                "gravatar_id": "",
15                "url": "https://api.github.com/users/octocat",
16                "html_url": "https://github.com/octocat",
17                "followers_url": "https://api.github.com/users/octocat/followers",
18                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
20                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
21                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
22                "organizations_url": "https://api.github.com/users/octocat/orgs",
23                "repos_url": "https://api.github.com/users/octocat/repos",
24                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
25                "received_events_url": "https://api.github.com/users/octocat/received_events",
26                "type": "User",
27                "site_admin": false
28            },
29            "html_url": "https://github.com/octocat/Hello-World",
30            "description": "This your first repo!",
31            "fork": false,
32            "url": "https://api.github.com/repos/octocat/Hello-World",
33            "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
34            "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
35            "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
36            "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
37            "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
38            "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
39            "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
40            "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
41            "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
42            "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
43            "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
44            "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
45            "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
46            "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
47            "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
48            "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
49            "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
50            "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
51            "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
52            "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
53            "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
54            "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
55            "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
56            "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
57            "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
58            "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
59            "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
60            "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
61            "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
62            "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
63            "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
64            "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
65            "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
66            "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
67            "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
68            "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
69            "created_at": "2023-05-15T12:00:00Z",
70            "updated_at": "2023-05-16T10:30:00Z",
71            "pushed_at": "2023-05-16T10:30:00Z",
72            "git_url": "git://github.com/octocat/Hello-World.git",
73            "ssh_url": "git@github.com:octocat/Hello-World.git",
74            "clone_url": "https://github.com/octocat/Hello-World.git",
75            "svn_url": "https://github.com/octocat/Hello-World",
76            "homepage": "https://github.com",
77            "size": 1024,
78            "stargazers_count": 80,
79            "watchers_count": 80,
80            "language": "JavaScript",
81            "has_issues": true,
82            "has_projects": true,
83            "has_downloads": true,
84            "has_wiki": true,
85            "has_pages": false,
86            "forks_count": 20,
87            "mirror_url": null,
88            "archived": false,
89            "disabled": false,
90            "open_issues_count": 2,
91            "license": {
92                "key": "mit",
93                "name": "MIT License",
94                "spdx_id": "MIT",
95                "url": "https://api.github.com/licenses/mit",
96                "node_id": "MDc6TGljZW5zZTEz"
97            },
98            "forks": 20,
99            "open_issues": 2,
100            "watchers": 80,
101            "default_branch": "main",
102            "permissions": {
103                "admin": true,
104                "push": true,
105                "pull": true
106            }
107        }
108    ],
109    "metadata": {
110        "first_page": 1,
111        "last_page": 3,
112        "next_page": 2,
113        "prev_page": null
114    }
115}

List your repositories
Copy

Lists your GitHub repositories.

Sample Input

1{
2    "filter": {
3        "visibility": "all",
4        "affiliation": {
5            "owner": true,
6            "collaborator": true,
7            "organization_member": true
8        }
9    },
10    "sort": "updated",
11    "direction": "desc",
12    "page": 1,
13    "per_page": 30
14}

Sample Output

1{
2    "results": [
3        {
4            "id": 123456789,
5            "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
6            "name": "my-awesome-project",
7            "full_name": "octocat/my-awesome-project",
8            "private": false,
9            "owner": {
10                "login": "octocat",
11                "id": 1234567,
12                "node_id": "MDQ6VXNlcjEyMzQ1Njc=",
13                "avatar_url": "https://avatars.githubusercontent.com/u/1234567?v=4",
14                "gravatar_id": "",
15                "url": "https://api.github.com/users/octocat",
16                "html_url": "https://github.com/octocat",
17                "followers_url": "https://api.github.com/users/octocat/followers",
18                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
19                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
20                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
21                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
22                "organizations_url": "https://api.github.com/users/octocat/orgs",
23                "repos_url": "https://api.github.com/users/octocat/repos",
24                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
25                "received_events_url": "https://api.github.com/users/octocat/received_events",
26                "type": "User",
27                "site_admin": false
28            },
29            "html_url": "https://github.com/octocat/my-awesome-project",
30            "description": "This is a sample project",
31            "fork": false,
32            "url": "https://api.github.com/repos/octocat/my-awesome-project",
33            "forks_url": "https://api.github.com/repos/octocat/my-awesome-project/forks",
34            "keys_url": "https://api.github.com/repos/octocat/my-awesome-project/keys{/key_id}",
35            "collaborators_url": "https://api.github.com/repos/octocat/my-awesome-project/collaborators{/collaborator}",
36            "teams_url": "https://api.github.com/repos/octocat/my-awesome-project/teams",
37            "hooks_url": "https://api.github.com/repos/octocat/my-awesome-project/hooks",
38            "issue_events_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/events{/number}",
39            "events_url": "https://api.github.com/repos/octocat/my-awesome-project/events",
40            "assignees_url": "https://api.github.com/repos/octocat/my-awesome-project/assignees{/user}",
41            "branches_url": "https://api.github.com/repos/octocat/my-awesome-project/branches{/branch}",
42            "tags_url": "https://api.github.com/repos/octocat/my-awesome-project/tags",
43            "blobs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/blobs{/sha}",
44            "git_tags_url": "https://api.github.com/repos/octocat/my-awesome-project/git/tags{/sha}",
45            "git_refs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/refs{/sha}",
46            "trees_url": "https://api.github.com/repos/octocat/my-awesome-project/git/trees{/sha}",
47            "statuses_url": "https://api.github.com/repos/octocat/my-awesome-project/statuses/{sha}",
48            "languages_url": "https://api.github.com/repos/octocat/my-awesome-project/languages",
49            "stargazers_url": "https://api.github.com/repos/octocat/my-awesome-project/stargazers",
50            "contributors_url": "https://api.github.com/repos/octocat/my-awesome-project/contributors",
51            "subscribers_url": "https://api.github.com/repos/octocat/my-awesome-project/subscribers",
52            "subscription_url": "https://api.github.com/repos/octocat/my-awesome-project/subscription",
53            "commits_url": "https://api.github.com/repos/octocat/my-awesome-project/commits{/sha}",
54            "git_commits_url": "https://api.github.com/repos/octocat/my-awesome-project/git/commits{/sha}",
55            "comments_url": "https://api.github.com/repos/octocat/my-awesome-project/comments{/number}",
56            "issue_comment_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/comments{/number}",
57            "contents_url": "https://api.github.com/repos/octocat/my-awesome-project/contents/{+path}",
58            "compare_url": "https://api.github.com/repos/octocat/my-awesome-project/compare/{base}...{head}",
59            "merges_url": "https://api.github.com/repos/octocat/my-awesome-project/merges",
60            "archive_url": "https://api.github.com/repos/octocat/my-awesome-project/{archive_format}{/ref}",
61            "downloads_url": "https://api.github.com/repos/octocat/my-awesome-project/downloads",
62            "issues_url": "https://api.github.com/repos/octocat/my-awesome-project/issues{/number}",
63            "pulls_url": "https://api.github.com/repos/octocat/my-awesome-project/pulls{/number}",
64            "milestones_url": "https://api.github.com/repos/octocat/my-awesome-project/milestones{/number}",
65            "notifications_url": "https://api.github.com/repos/octocat/my-awesome-project/notifications{?since,all,participating}",
66            "labels_url": "https://api.github.com/repos/octocat/my-awesome-project/labels{/name}",
67            "releases_url": "https://api.github.com/repos/octocat/my-awesome-project/releases{/id}",
68            "deployments_url": "https://api.github.com/repos/octocat/my-awesome-project/deployments",
69            "created_at": "2023-05-01T12:00:00Z",
70            "updated_at": "2023-05-15T14:30:00Z",
71            "pushed_at": "2023-05-15T14:30:00Z",
72            "git_url": "git://github.com/octocat/my-awesome-project.git",
73            "ssh_url": "git@github.com:octocat/my-awesome-project.git",
74            "clone_url": "https://github.com/octocat/my-awesome-project.git",
75            "svn_url": "https://github.com/octocat/my-awesome-project",
76            "homepage": "https://my-awesome-project.com",
77            "size": 1024,
78            "stargazers_count": 50,
79            "watchers_count": 50,
80            "language": "JavaScript",
81            "has_issues": true,
82            "has_projects": true,
83            "has_downloads": true,
84            "has_wiki": true,
85            "has_pages": false,
86            "forks_count": 10,
87            "mirror_url": null,
88            "archived": false,
89            "disabled": false,
90            "open_issues_count": 5,
91            "license": {
92                "key": "mit",
93                "name": "MIT License",
94                "spdx_id": "MIT",
95                "url": "https://api.github.com/licenses/mit",
96                "node_id": "MDc6TGljZW5zZTEz"
97            },
98            "forks": 10,
99            "open_issues": 5,
100            "watchers": 50,
101            "default_branch": "main",
102            "permissions": {
103                "admin": true,
104                "push": true,
105                "pull": true
106            }
107        }
108    ],
109    "metadata": {
110        "first_page": 1,
111        "last_page": 2,
112        "next_page": 2,
113        "prev_page": null
114    }
115}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1{
2    "method": "GET",
3    "url": {
4        "endpoint": "/repos/octocat/Hello-World/issues"
5    },
6    "headers": [
7        {
8            "key": "Accept",
9            "value": "application/vnd.github.v3+json"
10        }
11    ],
12    "query_parameters": [
13        {
14            "key": "state",
15            "value": "open"
16        },
17        {
18            "key": "per_page",
19            "value": "10"
20        }
21    ],
22    "body": {
23        "none": null
24    },
25    "include_raw_body": false,
26    "parse_response": "true"
27}

Sample Output

1{
2    "response": {
3        "status_code": 200,
4        "headers": {
5            "content-type": "application/json; charset=utf-8",
6            "x-ratelimit-limit": "5000",
7            "x-ratelimit-remaining": "4999"
8        },
9        "body": [
10            {
11                "id": 1,
12                "number": 1347,
13                "title": "Found a bug",
14                "state": "open",
15                "user": {
16                    "login": "octocat",
17                    "id": 1
18                },
19                "created_at": "2011-04-22T13:33:48Z",
20                "updated_at": "2011-04-22T13:33:48Z"
21            },
22            {
23                "id": 2,
24                "number": 1348,
25                "title": "New feature request",
26                "state": "open",
27                "user": {
28                    "login": "octocat",
29                    "id": 1
30                },
31                "created_at": "2011-04-22T14:53:23Z",
32                "updated_at": "2011-04-22T14:53:23Z"
33            }
34        ]
35    }
36}

Remove all branch protections
Copy

Removes all branch protections from a GitHub branch.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "branch": "main"
5}

Sample Output

1{
2    "deleted": true,
3    "existed": true
4}

Update branch protection
Copy

Updates the GitHub branch protection rules of a branch on a repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "branch": "main",
5    "required_status_checks": {
6        "strict": true,
7        "contexts": [
8            "ci/travis",
9            "security/brakeman"
10        ]
11    },
12    "enforce_admins": true,
13    "required_pull_request_reviews": {
14        "dismissal_restrictions": {
15            "users": [
16                "octocat"
17            ],
18            "teams": [
19                "core-team"
20            ]
21        },
22        "dismiss_stale_reviews": true,
23        "require_code_owner_reviews": true,
24        "required_approving_review_count": 2
25    },
26    "restrictions": {
27        "users": [
28            "octocat"
29        ],
30        "teams": [
31            "developers"
32        ]
33    },
34    "required_linear_history": true,
35    "allow_force_pushes": false,
36    "allow_deletions": false
37}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
3    "required_status_checks": {
4        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks",
5        "strict": true,
6        "contexts": [
7            "ci/travis",
8            "security/brakeman"
9        ],
10        "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks/contexts"
11    },
12    "restrictions": {
13        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions",
14        "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/users",
15        "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/teams",
16        "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/apps",
17        "users": [
18            {
19                "login": "octocat",
20                "id": 1,
21                "node_id": "MDQ6VXNlcjE=",
22                "avatar_url": "https://github.com/images/error/octocat_happy.gif",
23                "gravatar_id": "",
24                "url": "https://api.github.com/users/octocat",
25                "html_url": "https://github.com/octocat",
26                "followers_url": "https://api.github.com/users/octocat/followers",
27                "following_url": "https://api.github.com/users/octocat/following{/other_user}",
28                "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
29                "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
30                "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
31                "organizations_url": "https://api.github.com/users/octocat/orgs",
32                "repos_url": "https://api.github.com/users/octocat/repos",
33                "events_url": "https://api.github.com/users/octocat/events{/privacy}",
34                "received_events_url": "https://api.github.com/users/octocat/received_events",
35                "type": "User",
36                "site_admin": false
37            }
38        ],
39        "teams": [
40            {
41                "id": 1,
42                "node_id": "MDQ6VGVhbTE=",
43                "url": "https://api.github.com/teams/1",
44                "html_url": "https://github.com/orgs/github/teams/developers",
45                "name": "Developers",
46                "slug": "developers",
47                "description": "A team of developers",
48                "privacy": "closed",
49                "permission": "push",
50                "members_url": "https://api.github.com/teams/1/members{/member}",
51                "repositories_url": "https://api.github.com/teams/1/repos"
52            }
53        ],
54        "apps": []
55    },
56    "required_pull_request_reviews": {
57        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_pull_request_reviews",
58        "dismiss_stale_reviews": true,
59        "require_code_owner_reviews": true,
60        "required_approving_review_count": 2,
61        "dismissal_restrictions": {
62            "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions",
63            "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/users",
64            "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/teams",
65            "users": [
66                {
67                    "login": "octocat",
68                    "id": 1,
69                    "node_id": "MDQ6VXNlcjE=",
70                    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
71                    "gravatar_id": "",
72                    "url": "https://api.github.com/users/octocat",
73                    "html_url": "https://github.com/octocat",
74                    "followers_url": "https://api.github.com/users/octocat/followers",
75                    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
76                    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
77                    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
78                    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
79                    "organizations_url": "https://api.github.com/users/octocat/orgs",
80                    "repos_url": "https://api.github.com/users/octocat/repos",
81                    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
82                    "received_events_url": "https://api.github.com/users/octocat/received_events",
83                    "type": "User",
84                    "site_admin": false
85                }
86            ],
87            "teams": [
88                {
89                    "id": 1,
90                    "node_id": "MDQ6VGVhbTE=",
91                    "url": "https://api.github.com/teams/1",
92                    "html_url": "https://github.com/orgs/github/teams/core-team",
93                    "name": "Core Team",
94                    "slug": "core-team",
95                    "description": "A team of core developers",
96                    "privacy": "closed",
97                    "permission": "admin",
98                    "members_url": "https://api.github.com/teams/1/members{/member}",
99                    "repositories_url": "https://api.github.com/teams/1/repos"
100                }
101            ]
102        }
103    },
104    "enforce_admins": {
105        "url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/enforce_admins",
106        "enabled": true
107    },
108    "required_linear_history": {
109        "enabled": true
110    },
111    "allow_force_pushes": {
112        "enabled": false
113    },
114    "allow_deletions": {
115        "enabled": false
116    }
117}

Update issue
Copy

Updates an issue on a GitHub repository.

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "issue_number": 1347,
5    "title": "Updated: Found a bug",
6    "body": "I'm having a problem with this.",
7    "milestone": 1,
8    "labels": [
9        "bug",
10        "critical"
11    ],
12    "assignees": [
13        "octocat",
14        "hubot"
15    ]
16}

Sample Output

1{
2    "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
3    "repository_url": "https://api.github.com/repos/octocat/Hello-World",
4    "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
5    "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
6    "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
7    "html_url": "https://github.com/octocat/Hello-World/issues/1347",
8    "id": 1,
9    "node_id": "MDU6SXNzdWUx",
10    "number": 1347,
11    "title": "Updated: Found a bug",
12    "user": {
13        "login": "octocat",
14        "id": 1,
15        "node_id": "MDQ6VXNlcjE=",
16        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
17        "gravatar_id": "",
18        "url": "https://api.github.com/users/octocat",
19        "html_url": "https://github.com/octocat",
20        "followers_url": "https://api.github.com/users/octocat/followers",
21        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
22        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
23        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
24        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
25        "organizations_url": "https://api.github.com/users/octocat/orgs",
26        "repos_url": "https://api.github.com/users/octocat/repos",
27        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
28        "received_events_url": "https://api.github.com/users/octocat/received_events",
29        "type": "User",
30        "site_admin": false
31    },
32    "labels": [
33        {
34            "id": 208045946,
35            "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
36            "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
37            "name": "bug",
38            "color": "f29513",
39            "default": true
40        },
41        {
42            "id": 208045947,
43            "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
44            "url": "https://api.github.com/repos/octocat/Hello-World/labels/critical",
45            "name": "critical",
46            "color": "b60205",
47            "default": false
48        }
49    ],
50    "state": "open",
51    "locked": false,
52    "assignee": "octocat",
53    "assignees": [
54        "octocat",
55        "hubot"
56    ],
57    "milestone": "v1.0",
58    "comments": 0,
59    "created_at": "2011-04-22T13:33:48Z",
60    "updated_at": "2011-04-22T13:33:48Z",
61    "closed_at": null,
62    "author_association": "OWNER",
63    "body": "I'm having a problem with this.",
64    "closed_by": null
65}

Update repository
Copy

Update a repository

Sample Input

1{
2    "owner": "octocat",
3    "repository": "Hello-World",
4    "name": "Hello-World-Updated",
5    "description": "This is an updated description for the Hello World repository",
6    "homepage": "https://github.com",
7    "private": false,
8    "has_issues": true,
9    "has_projects": true,
10    "has_wiki": true,
11    "allow_squash_merge": true,
12    "allow_merge_commit": true,
13    "allow_rebase_merge": true,
14    "default_branch": "main",
15    "archived": false
16}

Sample Output

1{
2    "id": 1296269,
3    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
4    "name": "Hello-World-Updated",
5    "full_name": "octocat/Hello-World-Updated",
6    "private": false,
7    "owner": {
8        "login": "octocat",
9        "id": 1,
10        "node_id": "MDQ6VXNlcjE=",
11        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
12        "gravatar_id": "",
13        "url": "https://api.github.com/users/octocat",
14        "html_url": "https://github.com/octocat",
15        "followers_url": "https://api.github.com/users/octocat/followers",
16        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
17        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
18        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
19        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
20        "organizations_url": "https://api.github.com/users/octocat/orgs",
21        "repos_url": "https://api.github.com/users/octocat/repos",
22        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
23        "received_events_url": "https://api.github.com/users/octocat/received_events",
24        "type": "User",
25        "site_admin": false
26    },
27    "html_url": "https://github.com/octocat/Hello-World-Updated",
28    "description": "This is an updated description for the Hello World repository",
29    "fork": false,
30    "url": "https://api.github.com/repos/octocat/Hello-World-Updated",
31    "forks_url": "https://api.github.com/repos/octocat/Hello-World-Updated/forks",
32    "keys_url": "https://api.github.com/repos/octocat/Hello-World-Updated/keys{/key_id}",
33    "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Updated/collaborators{/collaborator}",
34    "teams_url": "https://api.github.com/repos/octocat/Hello-World-Updated/teams",
35    "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Updated/hooks",
36    "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Updated/issues/events{/number}",
37    "events_url": "https://api.github.com/repos/octocat/Hello-World-Updated/events",
38    "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Updated/assignees{/user}",
39    "branches_url": "https://api.github.com/repos/octocat/Hello-World-Updated/branches{/branch}",
40    "tags_url": "https://api.github.com/repos/octocat/Hello-World-Updated/tags",
41    "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Updated/git/blobs{/sha}",
42    "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Updated/git/tags{/sha}",
43    "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Updated/git/refs{/sha}",
44    "trees_url": "https://api.github.com/repos/octocat/Hello-World-Updated/git/trees{/sha}",
45    "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Updated/statuses/{sha}",
46    "languages_url": "https://api.github.com/repos/octocat/Hello-World-Updated/languages",
47    "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Updated/stargazers",
48    "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Updated/contributors",
49    "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Updated/subscribers",
50    "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Updated/subscription",
51    "commits_url": "https://api.github.com/repos/octocat/Hello-World-Updated/commits{/sha}",
52    "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Updated/git/commits{/sha}",
53    "comments_url": "https://api.github.com/repos/octocat/Hello-World-Updated/comments{/number}",
54    "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Updated/issues/comments{/number}",
55    "contents_url": "https://api.github.com/repos/octocat/Hello-World-Updated/contents/{+path}",
56    "compare_url": "https://api.github.com/repos/octocat/Hello-World-Updated/compare/{base}...{head}",
57    "merges_url": "https://api.github.com/repos/octocat/Hello-World-Updated/merges",
58    "archive_url": "https://api.github.com/repos/octocat/Hello-World-Updated/{archive_format}{/ref}",
59    "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Updated/downloads",
60    "issues_url": "https://api.github.com/repos/octocat/Hello-World-Updated/issues{/number}",
61    "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Updated/pulls{/number}",
62    "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Updated/milestones{/number}",
63    "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Updated/notifications{?since,all,participating}",
64    "labels_url": "https://api.github.com/repos/octocat/Hello-World-Updated/labels{/name}",
65    "releases_url": "https://api.github.com/repos/octocat/Hello-World-Updated/releases{/id}",
66    "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Updated/deployments",
67    "created_at": "2023-05-22T09:00:00Z",
68    "updated_at": "2023-05-22T10:00:00Z",
69    "pushed_at": "2023-05-22T10:00:00Z",
70    "git_url": "git://github.com/octocat/Hello-World-Updated.git",
71    "ssh_url": "git@github.com:octocat/Hello-World-Updated.git",
72    "clone_url": "https://github.com/octocat/Hello-World-Updated.git",
73    "svn_url": "https://github.com/octocat/Hello-World-Updated",
74    "homepage": "https://github.com",
75    "size": 1024,
76    "stargazers_count": 80,
77    "watchers_count": 80,
78    "language": "JavaScript",
79    "has_issues": true,
80    "has_projects": true,
81    "has_downloads": true,
82    "has_wiki": true,
83    "has_pages": false,
84    "forks_count": 9,
85    "mirror_url": null,
86    "archived": false,
87    "disabled": false,
88    "open_issues_count": 7,
89    "license": {
90        "key": "mit",
91        "name": "MIT License",
92        "spdx_id": "MIT",
93        "url": "https://api.github.com/licenses/mit",
94        "node_id": "MDc6TGljZW5zZTEz"
95    },
96    "forks": 9,
97    "open_issues": 7,
98    "watchers": 80,
99    "default_branch": "main",
100    "permissions": {
101        "admin": true,
102        "push": true,
103        "pull": true
104    },
105    "allow_squash_merge": true,
106    "allow_merge_commit": true,
107    "allow_rebase_merge": true,
108    "delete_branch_on_merge": false,
109    "network_count": 0,
110    "subscribers_count": 5
111}