---
title: "Get a GitHub Actions run mirrored from GitHub"
method: GET
path: "/api/repos/{owner}/{repo}/ci/github/runs/{suiteId}"
tags: ["CI"]
---

# Get a GitHub Actions run mirrored from GitHub

`GET /api/repos/{owner}/{repo}/ci/github/runs/{suiteId}`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/ci/github/runs/{suiteId}`
- Auth: one of:
  - none
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:contents:read`

Returns one mirrored GitHub Actions run by its GitHub check suite id, with every job (the latest attempt of each). `workflow` is read from GitHub on request with the repository's GitHub App installation (it needs Actions read permission); it is null when GitHub cannot be asked, and `workflow=false` skips the read (for polling). Each job's log is `…/ci/github/checks/:checkId/log` with the job's id. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

- `owner` string, required
- `repo` string, required
- `suiteId` string, required

## Query parameters

- `workflow` string

## Response `200`

Response for status 200

- object
  - `run` object, required
    - `id` string, required
    - `commitOid` string, required
    - `status` 'queued' | 'in_progress' | 'completed', required
    - `conclusion` string, nullable, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `completedAt` string, date-time, nullable, required
    - `jobCount` integer, required
    - `jobNames` string[], required
    - `url` string, required
  - `workflow` object, nullable, required
    - `name` string, required
    - `runNumber` integer, required
    - `attempt` integer, required
    - `event` string, required
    - `branch` string, nullable, required
    - `url` string, required
  - `jobs` object[], required
    - `id` string, required
    - `name` string, required
    - `status` 'queued' | 'in_progress' | 'completed', required
    - `conclusion` string, nullable, required
    - `startedAt` string, date-time, nullable, required
    - `completedAt` string, date-time, nullable, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)