# Get the combined status for a specific reference From **GitHub v3 REST API**. `GET /repos/{owner}/{repo}/commits/{ref}/status` Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Additionally, a combined `state` is returned. The `state` is one of: * **failure** if any of the contexts report as `error` or `failure` * **pending** if there are no statuses or a context is `pending` * **success** if the latest status for all contexts is `success` ## Parameters ### `owner` - Location: path - Required: true - Type: `string` ### `repo` - Location: path - Required: true - Type: `string` ### `ref` - Location: path - Required: true - Type: `string` ref parameter ### `per_page` - Location: query - Required: false - Type: `integer` - Default: `30` Results per page (max 100) ### `page` - Location: query - Required: false - Type: `integer` - Default: `1` Page number of the results to fetch. ## Responses ### `200` Response ### `application/json` - Type: `object` Combined Commit Status ```json { "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", "repository": { "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "This your first repo!", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "fork": false, "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "full_name": "octocat/Hello-World", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks", "html_url": "https://github.com/octocat/Hello-World", "id": 1296269, "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "name": "Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": false, "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "private": false, "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "url": "https://api.github.com/repos/octocat/Hello-World" }, "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "state": "success", "statuses": [ { "avatar_url": "https://github.com/images/error/hubot_happy.gif", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "description": "Build has completed successfully", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "target_url": "https://ci.example.com/1000/output", "updated_at": "2012-07-20T01:19:13Z", "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" }, { "avatar_url": "https://github.com/images/error/other_user_happy.gif", "context": "security/brakeman", "created_at": "2012-08-20T01:19:13Z", "description": "Testing has completed successfully", "id": 2, "node_id": "MDY6U3RhdHVzMg==", "state": "success", "target_url": "https://ci.example.com/2000/output", "updated_at": "2012-08-20T01:19:13Z", "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } ], "total_count": 2, "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" } ``` ```json {"description":"Combined Commit Status","properties":{"commit_url":{"format":"uri","type":"string"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"sha":{"type":"string"},"state":{"type":"string"},"statuses":{"items":{"$ref":"#/components/schemas/simple-commit-status"},"type":"array"},"total_count":{"type":"integer"},"url":{"format":"uri","type":"string"}},"required":["state","sha","total_count","statuses","repository","commit_url","url"],"title":"Combined Commit Status","type":"object"} ``` ### `404` Resource not found ### `application/json` - Type: `object` Basic Error ```json {"description":"Basic Error","properties":{"documentation_url":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"url":{"type":"string"}},"title":"Basic Error","type":"object"} ``` ## Request examples ### cURL ```shell curl --request GET \ --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/commits/{ref}/status ```