---
title: "List check runs in a check suite"
method: GET
path: "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"
tags: ["checks"]
---

# List check runs in a check suite

`GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`

**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.

## Path parameters

- `owner` string, required
- `repo` string, required
- `check_suite_id` integer, required

## Query parameters

- `check_name` string
- `status` 'queued' | 'in_progress' | 'completed'
- `filter` 'latest' | 'all'
- `per_page` integer
- `page` integer

## Response `200`

Response

- object
  - `total_count` integer, required
  - `check_runs` CheckRun[], required
    - `id` integer, required — The id of the check.
    - `head_sha` string, required — The SHA of the commit that is being checked.
    - `node_id` string, required
    - `external_id` string, nullable, required
    - `url` string, required
    - `html_url` string, nullable, required
    - `details_url` string, nullable, required
    - `status` 'queued' | 'in_progress' | 'completed', required — The phase of the lifecycle that the check is currently in.
    - `conclusion` 'success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required', nullable, required
    - `started_at` string, date-time, nullable, required
    - `completed_at` string, date-time, nullable, required
    - `output` object, required
      - `title` string, nullable, required
      - `summary` string, nullable, required
      - `text` string, nullable, required
      - `annotations_count` integer, required
      - `annotations_url` string, uri, required
    - `name` string, required — The name of the check.
    - `check_suite` object, nullable, required
      - `id` integer, required
    - `app` NullableIntegration, nullable, required — GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
      - `id` integer, required — Unique identifier of the GitHub app
      - `slug` string — The slug name of the GitHub app
      - `node_id` string, required
      - `owner` NullableSimpleUser, nullable, required — A GitHub user.
        - `name` string, nullable
        - `email` string, nullable
        - `login` string, required
        - `id` integer, required
        - `node_id` string, required
        - `avatar_url` string, uri, required
        - `gravatar_id` string, nullable, required
        - `url` string, uri, required
        - `html_url` string, uri, required
        - `followers_url` string, uri, required
        - `following_url` string, required
        - `gists_url` string, required
        - `starred_url` string, required
        - `subscriptions_url` string, uri, required
        - `organizations_url` string, uri, required
        - `repos_url` string, uri, required
        - `events_url` string, required
        - `received_events_url` string, uri, required
        - `type` string, required
        - `site_admin` boolean, required
        - `starred_at` string
      - `name` string, required — The name of the GitHub app
      - `description` string, nullable, required
      - `external_url` string, uri, required
      - `html_url` string, uri, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `permissions` object, required — The set of permissions for the GitHub app
        - `issues` string
        - `checks` string
        - `metadata` string
        - `contents` string
        - `deployments` string
      - `events` string[], required — The list of events for the GitHub app
      - `installations_count` integer — The number of installations associated with the GitHub app
      - `client_id` string
      - `client_secret` string
      - `webhook_secret` string, nullable
      - `pem` string
    - `pull_requests` PullRequestMinimal[], required — Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
      - `id` integer, required
      - `number` integer, required
      - `url` string, required
      - `head` object, required
        - `ref` string, required
        - `sha` string, required
        - `repo` object, required
          - `id` integer, required
          - `url` string, required
          - `name` string, required
      - `base` object, required
        - `ref` string, required
        - `sha` string, required
        - `repo` object, required
          - `id` integer, required
          - `url` string, required
          - `name` string, required
    - `deployment` DeploymentSimple — A deployment created as the result of an Actions check run from a workflow that references an environment
      - `url` string, uri, required
      - `id` integer, required — Unique identifier of the deployment
      - `node_id` string, required
      - `task` string, required — Parameter to specify a task to execute
      - `original_environment` string
      - `environment` string, required — Name for the target deployment environment.
      - `description` string, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `statuses_url` string, uri, required
      - `repository_url` string, uri, required
      - `transient_environment` boolean — Specifies if the given environment is will no longer exist at some point in the future. Default: false.
      - `production_environment` boolean — Specifies if the given environment is one that end-users directly interact with. Default: false.
      - `performed_via_github_app` NullableIntegration, nullable — GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
        - `id` integer, required — Unique identifier of the GitHub app
        - `slug` string — The slug name of the GitHub app
        - `node_id` string, required
        - `owner` NullableSimpleUser, nullable, required — A GitHub user.
          - `name` string, nullable
          - `email` string, nullable
          - `login` string, required
          - `id` integer, required
          - `node_id` string, required
          - `avatar_url` string, uri, required
          - `gravatar_id` string, nullable, required
          - `url` string, uri, required
          - `html_url` string, uri, required
          - `followers_url` string, uri, required
          - `following_url` string, required
          - `gists_url` string, required
          - `starred_url` string, required
          - `subscriptions_url` string, uri, required
          - `organizations_url` string, uri, required
          - `repos_url` string, uri, required
          - `events_url` string, required
          - `received_events_url` string, uri, required
          - `type` string, required
          - `site_admin` boolean, required
          - `starred_at` string
        - `name` string, required — The name of the GitHub app
        - `description` string, nullable, required
        - `external_url` string, uri, required
        - `html_url` string, uri, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `permissions` object, required — The set of permissions for the GitHub app
          - `issues` string
          - `checks` string
          - `metadata` string
          - `contents` string
          - `deployments` string
        - `events` string[], required — The list of events for the GitHub app
        - `installations_count` integer — The number of installations associated with the GitHub app
        - `client_id` string
        - `client_secret` string
        - `webhook_secret` string, nullable
        - `pem` string

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-4.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-4/versions/ee6c7a46328e/schema)