---
title: "Get Preview"
method: GET
path: "/api/folders/{library_id}/syncs/{sync_id}/preview"
tags: ["library-syncs"]
---

# Get Preview

`GET /api/folders/{library_id}/syncs/{sync_id}/preview`

## Request

- Base URL: `https://app.thinqos.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.thinqos.com/api/folders/{library_id}/syncs/{sync_id}/preview`
- Auth: none declared

Preview what the first run of a GitHub sync will do: files added, updated, different on both sides, already the same, and left alone.

## Path parameters

- `library_id` string, uuid, required
- `sync_id` string, uuid, required

## Headers

- `x-impersonate-identity-id` string, nullable

## Response `200`

Successful Response

- PreviewOut
  - `add` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `update` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `both` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `same` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `kept_out` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `not_syncable` PreviewItemOut[], required
    - `document_id` string, uuid, required
    - `title` string, required
    - `path` string, required
  - `github_only` string[], required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/thinqos/apis/thinqos-api.md) · [All operations](https://skmtc.dev/thinqos/apis/thinqos-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thinqos/apis/thinqos-api/revisions/ce2c2ce318b1?raw)