---
title: "Read issue sync"
method: GET
path: "/api/repos/{owner}/{repo}/issues/{issue}/sync"
tags: ["Issues"]
---

# Read issue sync

`GET /api/repos/{owner}/{repo}/issues/{issue}/sync`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/issues/{issue}/sync`
- 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: `issue:contents:read`

Read issue sync. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

- `owner` string, required
- `repo` string, required
- `issue` string, required

## Response `200`

Response for status 200

- object
  - `issueId` string, required
  - `configuration` object, nullable, required
    - `mode` 'manual' | 'gc2-leader' | 'github-leader', required
    - `syncIssues` boolean, required
    - `appIssuesWrite` boolean, required
  - `latest` object, nullable, required
    - `jobId` string, required
    - `localVersion` integer, required
    - `family` 'metadata' | 'lifecycle' | 'labels' | 'milestone' | 'assignees', required
    - `state` 'queued' | 'running' | 'succeeded' | 'blocked' | 'failed', required
    - `providerState` 'unsent' | 'confirmed' | 'outcome_unknown' | 'blocked' | 'not_delivered' | 'null', nullable, required
    - `reconciliationRequired` boolean, required
    - `reconciliationStale` boolean, required
  - `departure` union, required
    - object
      - `kind` 'deleted', required
    - object
      - `kind` 'transferred', required
      - `owner` string, required
      - `repository` string, required
      - `number` integer, required
      - `href` string, 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)