Operations (sample payloads)
Main operations
Add/update team membership
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 Sample Output
Create a release
Creates a release on a GitHub repository. Sample Input Sample Output
Create a status
Creates a status on a GitHub ref. Sample Input Sample Output
Create deploy key
Creates a deploy key for a specified repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"title": "Deploy key for production server",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHZYaOWfxzrOuCZRKdRobGjC9mxI6vFKlNlHbMNMWAOLd7kPpgBTOWMsNlkZAP4Ux/rjZojUcrnbm8tpjrConfR4y+bxwKU/sEEUgBh4B8ByC3snpI/A1L8yiBpvNIj7E5yKasWxvCxGx+XUFQNIzxkGSPqd3qZWfD/YTuhZQ0CTs2JvKl9QaGyS+3ZYK2Ue+YYgHvRXD+9WKmAXeGN5a8yFUz5LpfGwHZ5VsIzH/i3tVNWbzOhTi2/xkZBLwkWPUjGKhzz7QFTTj9tK0GBZ5NHaXEcVKC4DcEcwkOHHx7OjozxQxTg7Ym/ZK4TjSGUgb6WW/i0lD2PNhH6Y5QjYvP",
"read_only": true
\}
Sample Output
Create issue
Creates an issue on a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"title": "Found a bug",
"body": "I'm having a problem with this.",
"milestone": 1,
"labels": [
"bug",
"high-priority"
],
"assignees": [
"octocat",
"hubot"
]
\}
Sample Output
{
"name": "main",
"commit": {
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"commit": {
"author": \{
"name": "Monalisa Octocat",
"email": "mona@github.com",
"date": "2011-04-14T16:00:49Z"
\},
"committer": \{
"name": "GitHub",
"email": "noreply@github.com",
"date": "2011-04-14T16:00:49Z"
\},
"message": "Fix all the bugs",
"tree": \{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\},
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comment_count": 0,
"verification": \{
"verified": true,
"reason": "valid",
"signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----",
"payload": "tree 6dcb09b5b57875f334f61aebed695e2e4193db5e\n..."
\}
},
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"committer": {
"login": "web-flow",
"id": 19864447,
"node_id": "MDQ6VXNlcjE5ODY0NDQ3",
"avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/web-flow",
"html_url": "https://github.com/web-flow",
"followers_url": "https://api.github.com/users/web-flow/followers",
"following_url": "https://api.github.com/users/web-flow/following{/other_user}",
"gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
"starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
"organizations_url": "https://api.github.com/users/web-flow/orgs",
"repos_url": "https://api.github.com/users/web-flow/repos",
"events_url": "https://api.github.com/users/web-flow/events{/privacy}",
"received_events_url": "https://api.github.com/users/web-flow/received_events",
"type": "User",
"site_admin": false
},
"parents": [
\{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\}
]
},
"_links": \{
"self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
"html": "https://github.com/octocat/Hello-World/tree/main"
\},
"protected": true,
"protection": {
"enabled": true,
"required_status_checks": \{
"enforcement_level": "non_admins",
"contexts": [
"ci/travis"
]
\}
},
"protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
}
Create repository
Create a new repository. Sample Input
\{
"name": "my-awesome-project",
"description": "This repository contains my awesome project",
"homepage": "https://myawesomeproject.com",
"private": false,
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"allow_squash_merge": true,
"allow_merge_commit": true,
"allow_rebase_merge": true,
"auto_init": true,
"gitignore_template": "Node",
"license_template": "mit"
\}
Sample Output
Delete deploy key
Deletes a specified deploy key. Sample Input Sample Output
Delete repository
Delete a GitHub repository. Sample Input Sample Output
{
"success": true
}
Get a single reference
Retrieves a single reference from your Git database. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"reference": "heads/main"
\}
Sample Output
Get branch
Retrieves the branch of a GitHub repository. Sample Input Sample Output
{
"name": "main",
"commit": {
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"commit": {
"author": \{
"name": "Monalisa Octocat",
"date": "2011-04-14T16:00:49Z",
"email": "mona@github.com"
\},
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"message": "Fix all the bugs",
"tree": \{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\},
"committer": \{
"name": "Monalisa Octocat",
"date": "2011-04-14T16:00:49Z",
"email": "mona@github.com"
\},
"verification": \{
"verified": true,
"reason": "valid",
"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",
"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"
\}
},
"author": \{
"gravatar_id": "",
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
"url": "https://api.github.com/users/octocat",
"id": 583231,
"login": "octocat"
\},
"parents": [
\{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\}
],
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"committer": \{
"gravatar_id": "",
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
"url": "https://api.github.com/users/octocat",
"id": 583231,
"login": "octocat"
\}
},
"_links": \{
"html": "https://github.com/octocat/Hello-World/tree/main",
"self": "https://api.github.com/repos/octocat/Hello-World/branches/main"
\},
"protected": false,
"protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
}
Get branch protection
Retrieves the GitHub branch protection rules of a branch on a repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"branch": "main"
\}
Sample Output
{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
"required_status_checks": \{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks",
"strict": true,
"contexts": [
"continuous-integration/travis-ci",
"codecov/patch",
"codecov/project"
],
"contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks/contexts"
\},
"restrictions": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions",
"users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/users",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/teams",
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
],
"teams": [
"core-team"
]
},
"required_pull_request_reviews": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_pull_request_reviews",
"dismiss_stale_reviews": true,
"require_code_owner_reviews": true,
"dismissal_restrictions": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions",
"users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/users",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/teams",
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
],
"teams": [
"core-team"
]
}
},
"enforce_admins": \{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/enforce_admins",
"enabled": true
\}
}
Get commit
Get a commit in a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
\}
Sample Output
{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"commit": {
"author": \{
"name": "Monalisa Octocat",
"email": "mona@github.com",
"date": "2011-04-14T16:00:49Z"
\},
"committer": \{
"name": "Monalisa Octocat",
"email": "mona@github.com",
"date": "2011-04-14T16:00:49Z"
\},
"message": "Fix all the bugs",
"tree": \{
"sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
\},
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comment_count": 0,
"verification": \{
"verified": false,
"reason": "unsigned",
"signature": null,
"payload": null
\}
},
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"committer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"parents": [
\{
"sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
"html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
\}
],
"stats": \{
"total": 2,
"additions": 1,
"deletions": 1
\},
"files": [
\{
"sha": "980a0d5f19a64b4b30a87d4206aade58726b60e3",
"filename": "file1.txt",
"status": "modified",
"additions": 1,
"deletions": 1,
"changes": 2,
"blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
"raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
"patch": "@@ -29,7 +29,7 @@\n...\n-test\n+update test\n..."
\}
]
}
Get deploy key
Retrieves information for a specified deploy key. Sample Input Sample Output
\{
"id": 1234567,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1234567",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true
\}
Get issue
Retrieves an issue of a GitHub repository by its number. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"issue_number": 1347
\}
Sample Output
{
"url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"repository_url": "https://api.github.com/repos/octocat/Hello-World",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
"events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
"html_url": "https://github.com/octocat/Hello-World/issues/1347",
"id": 123456,
"node_id": "MDU6SXNzdWUxMjM0NTY=",
"number": 1347,
"title": "Found a bug",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"labels": [
"bug"
],
"state": "open",
"locked": false,
"assignee": "octocat",
"assignees": [
"octocat"
],
"milestone": "v1.0",
"comments": 0,
"created_at": "2011-04-22T13:33:48Z",
"updated_at": "2011-04-22T13:33:48Z",
"closed_at": null,
"author_association": "OWNER",
"pull_request": \{
"url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
"html_url": "https://github.com/octocat/Hello-World/pull/1347",
"diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
"patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
\},
"body": "I'm having a problem with this.",
"closed_by": null
}
Get repository
Get details about a GitHub repository. Sample Input Sample Output
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"private": false,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications\{?since,all,participating\}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"pushed_at": "2011-01-26T19:06:43Z",
"git_url": "git://github.com/octocat/Hello-World.git",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"clone_url": "https://github.com/octocat/Hello-World.git",
"svn_url": "https://github.com/octocat/Hello-World",
"homepage": "https://github.com",
"size": 108,
"stargazers_count": 80,
"watchers_count": 80,
"language": "JavaScript",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"forks_count": 9,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 0,
"license": \{
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit",
"node_id": "MDc6TGljZW5zZTEz"
\},
"forks": 9,
"open_issues": 0,
"watchers": 80,
"default_branch": "master",
"permissions": \{
"admin": false,
"push": false,
"pull": true
\},
"temp_clone_token": null,
"allow_squash_merge": true,
"allow_merge_commit": true,
"allow_rebase_merge": true,
"delete_branch_on_merge": false,
"network_count": 0,
"subscribers_count": 1
}
Get team
Retrieves information for a team using the team‘s name. Sample Input
\{
"organization": "acme-corp",
"team_slug": "engineering"
\}
Sample Output
{
"name": "Engineering",
"id": 1234567,
"node_id": "MDQ6VGVhbTEyMzQ1Njc=",
"slug": "engineering",
"description": "ACME Corp Engineering Team",
"privacy": "closed",
"url": "https://api.github.com/organizations/9876543/team/1234567",
"html_url": "https://github.com/orgs/acme-corp/teams/engineering",
"members_url": "https://api.github.com/organizations/9876543/team/1234567/members{/member}",
"repositories_url": "https://api.github.com/organizations/9876543/team/1234567/repos",
"permission": "push",
"created_at": "2023-05-15T10:30:00Z",
"updated_at": "2023-05-20T14:45:30Z",
"members_count": 25,
"repos_count": 15,
"organization": {
"login": "acme-corp",
"id": 9876543,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk4NzY1NDM=",
"url": "https://api.github.com/orgs/acme-corp",
"repos_url": "https://api.github.com/orgs/acme-corp/repos",
"events_url": "https://api.github.com/orgs/acme-corp/events",
"hooks_url": "https://api.github.com/orgs/acme-corp/hooks",
"issues_url": "https://api.github.com/orgs/acme-corp/issues",
"members_url": "https://api.github.com/orgs/acme-corp/members{/member}",
"public_members_url": "https://api.github.com/orgs/acme-corp/public_members{/member}",
"avatar_url": "https://avatars.githubusercontent.com/u/9876543?v=4",
"description": "ACME Corporation - Innovative Solutions",
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
"public_repos": 30,
"public_gists": 5,
"followers": 1000,
"following": 50,
"html_url": "https://github.com/acme-corp",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2023-05-20T14:45:30Z",
"type": "Organization"
},
"parent": null
}
Get the latest published release
Retrieves the latest published release of a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World"
\}
Sample Output
Get user
Retrieves information on a specified user. Sample Input
{
"username": "octocat"
}
Sample Output
{
"login": "octocat",
"id": 583231,
"node_id": "MDQ6VXNlcjU4MzIzMQ==",
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false,
"name": "The Octocat",
"company": "@github",
"blog": "https://github.blog",
"location": "San Francisco",
"email": null,
"hireable": null,
"bio": "I'm the GitHub mascot!",
"public_repos": 8,
"public_gists": 8,
"followers": 6958,
"following": 9,
"created_at": "2011-01-25T18:44:36Z",
"updated_at": "2023-05-22T14:15:37Z"
}
List branches
Lists the branches of a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"protected": false,
"page": 1,
"per_page": 30
\}
Sample Output
{
"results": [
{
"name": "main",
"commit": \{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\},
"protected": true
},
{
"name": "feature-branch",
"commit": \{
"sha": "f45ad9d5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/f45ad9d5b57875f334f61aebed695e2e4193db5e"
\},
"protected": false
}
],
"metadata": \{
"first_page": 1,
"last_page": 2,
"next_page": 2,
"prev_page": null
\}
}
List collaborators
Lists all collaborators for the specified repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"affiliation": "all",
"page": 1,
"per_page": 30
\}
Sample Output
List deploy keys
Lists the deploy keys for a specified repository. Sample Input Sample Output
{
"results": [
\{
"id": 1,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true
\},
\{
"id": 2,
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/2",
"title": "deploy-key-2",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": false
\}
]
}
List languages
Lists the languages of a GitHub repository. Sample Input Sample Output
\{
"JavaScript": 3541,
"Python": 2856,
"HTML": 1204,
"CSS": 876,
"Ruby": 540
\}
List matching references
Lists matching GitHub references. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"reference": "heads/main"
\}
Sample Output
{
"results": [
{
"ref": "refs/heads/main",
"node_id": "MDM6UmVmcmVmczpoZWFkcy9tYWlu",
"url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/main",
"object": \{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"type": "commit",
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\}
}
],
"metadata": \{
"first_page": 1,
"last_page": 1,
"next_page": null,
"prev_page": null
\}
}
List organization members
Lists members of an organization. Sample Input Sample Output
List organization repositories
List an organization's GitHub repositories. Sample Input Sample Output
List organization teams
Lists all teams in an organization that are visible to the authenticated user. Sample Input
\{
"organization": "acme-corp",
"page": 1,
"per_page": 30
\}
Sample Output
{
"results": [
{
"name": "Engineering",
"id": 1234567,
"node_id": "MDQ6VGVhbTEyMzQ1Njc=",
"slug": "engineering",
"description": "ACME Corp Engineering Team",
"privacy": "closed",
"url": "https://api.github.com/teams/1234567",
"html_url": "https://github.com/orgs/acme-corp/teams/engineering",
"members_url": "https://api.github.com/teams/1234567/members{/member}",
"repositories_url": "https://api.github.com/teams/1234567/repos",
"permission": "pull",
"parent": null
},
{
"name": "Marketing",
"id": 2345678,
"node_id": "MDQ6VGVhbTIzNDU2Nzg=",
"slug": "marketing",
"description": "ACME Corp Marketing Team",
"privacy": "secret",
"url": "https://api.github.com/teams/2345678",
"html_url": "https://github.com/orgs/acme-corp/teams/marketing",
"members_url": "https://api.github.com/teams/2345678/members{/member}",
"repositories_url": "https://api.github.com/teams/2345678/repos",
"permission": "pull",
"parent": null
}
],
"metadata": \{
"first_page": 1,
"last_page": 2,
"next_page": 2,
"prev_page": null
\}
}
List repository commits
List the commits of a GitHub repository. Sample Input Sample Output
{
"results": [
{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"commit": {
"author": \{
"name": "Monalisa Octocat",
"email": "octocat@github.com",
"date": "2023-06-15T23:45:32Z"
\},
"committer": \{
"name": "GitHub",
"email": "noreply@github.com",
"date": "2023-06-15T23:45:32Z"
\},
"message": "Update README.md",
"tree": \{
"sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312"
\},
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comment_count": 0,
"verification": \{
"verified": true,
"reason": "valid",
"signature": "-----BEGIN PGP SIGNATURE-----\n\nwsBcBAABCAAQBQJa+rDICRBK7hj4Ov3rIwAAdHIIAGSZr9M+t7...",
"payload": "tree 9fb037999f264ba9a7fc6274d15fa3ae2ab98312\nparent 7d1b31e74ee336d15cbd21741bc88a537ed063a0\nauthor Monalisa Octocat <octocat@github.com> 1529107532 -0700\ncommitter GitHub <noreply@github.com> 1529107532 -0700\n\nUpdate README.md"
\}
},
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"committer": {
"login": "web-flow",
"id": 19864447,
"node_id": "MDQ6VXNlcjE5ODY0NDQ3",
"avatar_url": "https://avatars3.githubusercontent.com/u/19864447?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/web-flow",
"html_url": "https://github.com/web-flow",
"followers_url": "https://api.github.com/users/web-flow/followers",
"following_url": "https://api.github.com/users/web-flow/following{/other_user}",
"gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
"starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
"organizations_url": "https://api.github.com/users/web-flow/orgs",
"repos_url": "https://api.github.com/users/web-flow/repos",
"events_url": "https://api.github.com/users/web-flow/events{/privacy}",
"received_events_url": "https://api.github.com/users/web-flow/received_events",
"type": "User",
"site_admin": false
},
"parents": [
\{
"sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0",
"html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0"
\}
]
}
],
"metadata": \{
"first_page": 1,
"last_page": 3,
"next_page": 2,
"prev_page": null
\}
}
List repository contributors
List all of the contributors to a GitHub repository. Sample Input Sample Output
{
"results": [
{
"sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
"node_id": "MDQ6VXNlcjE=",
"commit": {
"author": \{
"name": "Monalisa Octocat",
"email": "octocat@github.com",
"date": "2023-05-15T14:30:00Z"
\},
"committer": \{
"name": "GitHub",
"email": "noreply@github.com",
"date": "2023-05-15T14:30:00Z"
\},
"message": "Fix typo in README",
"tree": \{
"sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
\},
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
"comment_count": 0,
"verification": \{
"verified": true,
"reason": "valid",
"signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----",
"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"
\}
},
"url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
"html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"committer": {
"login": "web-flow",
"id": 19864447,
"node_id": "MDQ6VXNlcjE5ODY0NDQ3",
"avatar_url": "https://avatars.githubusercontent.com/u/19864447?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/web-flow",
"html_url": "https://github.com/web-flow",
"followers_url": "https://api.github.com/users/web-flow/followers",
"following_url": "https://api.github.com/users/web-flow/following{/other_user}",
"gists_url": "https://api.github.com/users/web-flow/gists{/gist_id}",
"starred_url": "https://api.github.com/users/web-flow/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/web-flow/subscriptions",
"organizations_url": "https://api.github.com/users/web-flow/orgs",
"repos_url": "https://api.github.com/users/web-flow/repos",
"events_url": "https://api.github.com/users/web-flow/events{/privacy}",
"received_events_url": "https://api.github.com/users/web-flow/received_events",
"type": "User",
"site_admin": false
},
"parents": [
\{
"sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
"html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
\}
]
}
],
"metadata": \{
"first_page": 1,
"last_page": 2,
"next_page": 2,
"prev_page": null
\}
}
List repository forks
List all of the forks of a GitHub repository. Sample Input Sample Output
{
"results": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World-Fork",
"full_name": "octocat-fork/Hello-World-Fork",
"private": false,
"owner": {
"login": "octocat-fork",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat-fork",
"html_url": "https://github.com/octocat-fork",
"followers_url": "https://api.github.com/users/octocat-fork/followers",
"following_url": "https://api.github.com/users/octocat-fork/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat-fork/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat-fork/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat-fork/subscriptions",
"organizations_url": "https://api.github.com/users/octocat-fork/orgs",
"repos_url": "https://api.github.com/users/octocat-fork/repos",
"events_url": "https://api.github.com/users/octocat-fork/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat-fork/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octocat-fork/Hello-World-Fork",
"description": "This is your first repo!",
"fork": true,
"url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork",
"forks_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/forks",
"keys_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/teams",
"hooks_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/hooks",
"issue_events_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues/events{/number}",
"events_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/events",
"assignees_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/assignees{/user}",
"branches_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/branches{/branch}",
"tags_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/tags",
"blobs_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/languages",
"stargazers_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/stargazers",
"contributors_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/contributors",
"subscribers_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/subscribers",
"subscription_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/subscription",
"commits_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/contents/{+path}",
"compare_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/merges",
"archive_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/downloads",
"issues_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/issues{/number}",
"pulls_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/notifications\{?since,all,participating\}",
"labels_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/labels{/name}",
"releases_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/releases{/id}",
"deployments_url": "https://api.github.com/repos/octocat-fork/Hello-World-Fork/deployments",
"created_at": "2020-01-20T22:42:08Z",
"updated_at": "2020-01-20T22:42:08Z",
"pushed_at": "2020-01-20T22:42:08Z",
"git_url": "git://github.com/octocat-fork/Hello-World-Fork.git",
"ssh_url": "git@github.com:octocat-fork/Hello-World-Fork.git",
"clone_url": "https://github.com/octocat-fork/Hello-World-Fork.git",
"svn_url": "https://github.com/octocat-fork/Hello-World-Fork",
"homepage": "https://github.com",
"size": 108,
"stargazers_count": 80,
"watchers_count": 80,
"language": "JavaScript",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"forks_count": 9,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 7,
"license": "MIT",
"forks": 9,
"open_issues": 7,
"watchers": 80,
"default_branch": "master",
"permissions": \{
"admin": false,
"push": false,
"pull": true
\}
}
],
"metadata": \{
"first_page": 1,
"last_page": 3,
"next_page": 2,
"prev_page": null
\}
}
List repository issues
Lists issues of a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"state": "open",
"labels": [
"bug",
"enhancement"
],
"sort": "created",
"direction": "desc",
"since": "2023-01-01T00:00:00Z",
"page": 1,
"per_page": 30
\}
Sample Output
List repository teams
Lists the teams of a GitHub repository. Sample Input Sample Output
{
"results": [
{
"name": "Developers",
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"slug": "developers",
"description": "Core development team",
"privacy": "closed",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/octocat/teams/developers",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"permission": "push",
"parent": null
},
{
"name": "Reviewers",
"id": 2,
"node_id": "MDQ6VGVhbTI=",
"slug": "reviewers",
"description": "Code review team",
"privacy": "closed",
"url": "https://api.github.com/teams/2",
"html_url": "https://github.com/orgs/octocat/teams/reviewers",
"members_url": "https://api.github.com/teams/2/members{/member}",
"repositories_url": "https://api.github.com/teams/2/repos",
"permission": "pull",
"parent": null
}
],
"metadata": \{
"first_page": 1,
"last_page": 1,
"next_page": null,
"prev_page": null
\}
}
List tags
Lists the tags of a GitHub repository. Sample Input Sample Output
{
"results": [
{
"name": "v1.0.0",
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
"commit": \{
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
\},
"node_id": "MDM6UmVmcmVmczp0YWdzL3YxLjAuMA=="
},
{
"name": "v0.9.0",
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v0.9.0",
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v0.9.0",
"commit": \{
"sha": "f3e87f0cecb4f3af0f4c1d14fd6d11096d3e8740",
"url": "https://api.github.com/repos/octocat/Hello-World/commits/f3e87f0cecb4f3af0f4c1d14fd6d11096d3e8740"
\},
"node_id": "MDM6UmVmcmVmczp0YWdzL3YwLjkuMA=="
}
],
"metadata": \{
"first_page": 1,
"last_page": 2,
"next_page": 2,
"prev_page": null
\}
}
List team members
Lists members of a team. Sample Input
\{
"organization": "acme-corp",
"team_slug": "developers",
"role": "all",
"page": 1,
"per_page": 100
\}
Sample Output
List user repositories
Lists a user GitHub repositories. Sample Input Sample Output
{
"results": [
{
"id": 123456789,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"private": false,
"owner": {
"login": "octocat",
"id": 1234567,
"node_id": "MDQ6VXNlcjEyMzQ1Njc=",
"avatar_url": "https://avatars.githubusercontent.com/u/1234567?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications\{?since,all,participating\}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"created_at": "2023-05-15T12:00:00Z",
"updated_at": "2023-05-16T10:30:00Z",
"pushed_at": "2023-05-16T10:30:00Z",
"git_url": "git://github.com/octocat/Hello-World.git",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"clone_url": "https://github.com/octocat/Hello-World.git",
"svn_url": "https://github.com/octocat/Hello-World",
"homepage": "https://github.com",
"size": 1024,
"stargazers_count": 80,
"watchers_count": 80,
"language": "JavaScript",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"forks_count": 20,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 2,
"license": \{
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit",
"node_id": "MDc6TGljZW5zZTEz"
\},
"forks": 20,
"open_issues": 2,
"watchers": 80,
"default_branch": "main",
"permissions": \{
"admin": true,
"push": true,
"pull": true
\}
}
],
"metadata": \{
"first_page": 1,
"last_page": 3,
"next_page": 2,
"prev_page": null
\}
}
List your repositories
Lists your GitHub repositories. Sample Input
{
"filter": {
"visibility": "all",
"affiliation": \{
"owner": true,
"collaborator": true,
"organization_member": true
\}
},
"sort": "updated",
"direction": "desc",
"page": 1,
"per_page": 30
}
Sample Output
{
"results": [
{
"id": 123456789,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY3ODk=",
"name": "my-awesome-project",
"full_name": "octocat/my-awesome-project",
"private": false,
"owner": {
"login": "octocat",
"id": 1234567,
"node_id": "MDQ6VXNlcjEyMzQ1Njc=",
"avatar_url": "https://avatars.githubusercontent.com/u/1234567?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octocat/my-awesome-project",
"description": "This is a sample project",
"fork": false,
"url": "https://api.github.com/repos/octocat/my-awesome-project",
"forks_url": "https://api.github.com/repos/octocat/my-awesome-project/forks",
"keys_url": "https://api.github.com/repos/octocat/my-awesome-project/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octocat/my-awesome-project/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octocat/my-awesome-project/teams",
"hooks_url": "https://api.github.com/repos/octocat/my-awesome-project/hooks",
"issue_events_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/events{/number}",
"events_url": "https://api.github.com/repos/octocat/my-awesome-project/events",
"assignees_url": "https://api.github.com/repos/octocat/my-awesome-project/assignees{/user}",
"branches_url": "https://api.github.com/repos/octocat/my-awesome-project/branches{/branch}",
"tags_url": "https://api.github.com/repos/octocat/my-awesome-project/tags",
"blobs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/my-awesome-project/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/my-awesome-project/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octocat/my-awesome-project/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octocat/my-awesome-project/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octocat/my-awesome-project/languages",
"stargazers_url": "https://api.github.com/repos/octocat/my-awesome-project/stargazers",
"contributors_url": "https://api.github.com/repos/octocat/my-awesome-project/contributors",
"subscribers_url": "https://api.github.com/repos/octocat/my-awesome-project/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/my-awesome-project/subscription",
"commits_url": "https://api.github.com/repos/octocat/my-awesome-project/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octocat/my-awesome-project/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octocat/my-awesome-project/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octocat/my-awesome-project/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octocat/my-awesome-project/contents/{+path}",
"compare_url": "https://api.github.com/repos/octocat/my-awesome-project/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octocat/my-awesome-project/merges",
"archive_url": "https://api.github.com/repos/octocat/my-awesome-project/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octocat/my-awesome-project/downloads",
"issues_url": "https://api.github.com/repos/octocat/my-awesome-project/issues{/number}",
"pulls_url": "https://api.github.com/repos/octocat/my-awesome-project/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octocat/my-awesome-project/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/my-awesome-project/notifications\{?since,all,participating\}",
"labels_url": "https://api.github.com/repos/octocat/my-awesome-project/labels{/name}",
"releases_url": "https://api.github.com/repos/octocat/my-awesome-project/releases{/id}",
"deployments_url": "https://api.github.com/repos/octocat/my-awesome-project/deployments",
"created_at": "2023-05-01T12:00:00Z",
"updated_at": "2023-05-15T14:30:00Z",
"pushed_at": "2023-05-15T14:30:00Z",
"git_url": "git://github.com/octocat/my-awesome-project.git",
"ssh_url": "git@github.com:octocat/my-awesome-project.git",
"clone_url": "https://github.com/octocat/my-awesome-project.git",
"svn_url": "https://github.com/octocat/my-awesome-project",
"homepage": "https://my-awesome-project.com",
"size": 1024,
"stargazers_count": 50,
"watchers_count": 50,
"language": "JavaScript",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"forks_count": 10,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 5,
"license": \{
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit",
"node_id": "MDc6TGljZW5zZTEz"
\},
"forks": 10,
"open_issues": 5,
"watchers": 50,
"default_branch": "main",
"permissions": \{
"admin": true,
"push": true,
"pull": true
\}
}
],
"metadata": \{
"first_page": 1,
"last_page": 2,
"next_page": 2,
"prev_page": null
\}
}
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input
{
"method": "GET",
"url": {
"endpoint": "/repos/octocat/Hello-World/issues"
},
"headers": [
\{
"key": "Accept",
"value": "application/vnd.github.v3+json"
\}
],
"query_parameters": [
\{
"key": "state",
"value": "open"
\},
\{
"key": "per_page",
"value": "10"
\}
],
"body": {
"none": null
},
"include_raw_body": false,
"parse_response": "true"
}
Sample Output
{
"response": {
"status_code": 200,
"headers": \{
"content-type": "application/json; charset=utf-8",
"x-ratelimit-limit": "5000",
"x-ratelimit-remaining": "4999"
\},
"body": [
{
"id": 1,
"number": 1347,
"title": "Found a bug",
"state": "open",
"user": \{
"login": "octocat",
"id": 1
\},
"created_at": "2011-04-22T13:33:48Z",
"updated_at": "2011-04-22T13:33:48Z"
},
{
"id": 2,
"number": 1348,
"title": "New feature request",
"state": "open",
"user": \{
"login": "octocat",
"id": 1
\},
"created_at": "2011-04-22T14:53:23Z",
"updated_at": "2011-04-22T14:53:23Z"
}
]
}
}
Remove all branch protections
Removes all branch protections from a GitHub branch. Sample Input Sample Output
\{
"deleted": true,
"existed": true
\}
Update branch protection
Updates the GitHub branch protection rules of a branch on a repository. Sample Input
{
"owner": "octocat",
"repository": "Hello-World",
"branch": "main",
"required_status_checks": \{
"strict": true,
"contexts": [
"ci/travis",
"security/brakeman"
]
\},
"enforce_admins": true,
"required_pull_request_reviews": {
"dismissal_restrictions": \{
"users": [
"octocat"
],
"teams": [
"core-team"
]
\},
"dismiss_stale_reviews": true,
"require_code_owner_reviews": true,
"required_approving_review_count": 2
},
"restrictions": \{
"users": [
"octocat"
],
"teams": [
"developers"
]
\},
"required_linear_history": true,
"allow_force_pushes": false,
"allow_deletions": false
}
Sample Output
{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
"required_status_checks": \{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks",
"strict": true,
"contexts": [
"ci/travis",
"security/brakeman"
],
"contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_status_checks/contexts"
\},
"restrictions": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions",
"users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/users",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/teams",
"apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/restrictions/apps",
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
],
"teams": [
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/developers",
"name": "Developers",
"slug": "developers",
"description": "A team of developers",
"privacy": "closed",
"permission": "push",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos"
}
],
"apps": []
},
"required_pull_request_reviews": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_pull_request_reviews",
"dismiss_stale_reviews": true,
"require_code_owner_reviews": true,
"required_approving_review_count": 2,
"dismissal_restrictions": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions",
"users_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/users",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/dismissal_restrictions/teams",
"users": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
],
"teams": [
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/core-team",
"name": "Core Team",
"slug": "core-team",
"description": "A team of core developers",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos"
}
]
}
},
"enforce_admins": \{
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/enforce_admins",
"enabled": true
\},
"required_linear_history": {
"enabled": true
},
"allow_force_pushes": {
"enabled": false
},
"allow_deletions": {
"enabled": false
}
}
Update issue
Updates an issue on a GitHub repository. Sample Input
\{
"owner": "octocat",
"repository": "Hello-World",
"issue_number": 1347,
"title": "Updated: Found a bug",
"body": "I'm having a problem with this.",
"milestone": 1,
"labels": [
"bug",
"critical"
],
"assignees": [
"octocat",
"hubot"
]
\}
Sample Output
Update repository
Update a repository Sample Input Sample Output
DDL operations
List deploy keys (DDL)
Sample Input
{}
Sample Output
List organization teams (DDL)
Sample Input Sample Output
[
{
"id": 1234567,
"node_id": "T_kwDOABcdefg",
"url": "https://api.github.com/teams/1234567",
"html_url": "https://github.com/orgs/example-org/teams/developers",
"name": "Developers",
"slug": "developers",
"description": "Core development team",
"privacy": "closed",
"permission": "push",
"members_url": "https://api.github.com/teams/1234567/members{/member}",
"repositories_url": "https://api.github.com/teams/1234567/repos",
"parent": null
},
{
"id": 2345678,
"node_id": "T_kwDOBCdefgh",
"url": "https://api.github.com/teams/2345678",
"html_url": "https://github.com/orgs/example-org/teams/designers",
"name": "Designers",
"slug": "designers",
"description": "UI/UX design team",
"privacy": "secret",
"permission": "pull",
"members_url": "https://api.github.com/teams/2345678/members{/member}",
"repositories_url": "https://api.github.com/teams/2345678/repos",
"parent": null
}
]
List user organization IDs (DDL)
Sample Input
{}
Sample Output
List user organizations (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List user repositories (DDL)
Sample Input Sample Output