---
title: "GET /api/v1/two-way-sync/{spaceId}/files/status"
method: GET
path: "/api/v1/two-way-sync/{spaceId}/files/status"
---

# GET /api/v1/two-way-sync/{spaceId}/files/status

`GET /api/v1/two-way-sync/{spaceId}/files/status`

## Request

- Base URL: `https://falconer.com` (the document declares no server; this is the origin it was published from)
- URL: `https://falconer.com/api/v1/two-way-sync/{spaceId}/files/status`
- Auth: none declared

## Path parameters

- `spaceId` integer, required: Space id, from GET /spaces.

## Query parameters

- `path` string: Path relative to the sync root. Pass this or fileNodeId.
- `fileNodeId` string

## Headers

- `x-organization-id` string: Required when using OAuth bearer tokens.

## Response `200`

Sync status of one file.

- TwoWaySyncFileEntry
  - `path` string, required: Path relative to the sync root.
  - `repoPath` string, required: Path in the repository.
  - `fileNodeId` string, nullable, required
  - `kind` 'markdown' | 'text' | 'config' | 'opaque', required
  - `documentId` string, nullable, required
  - `title` string, nullable, required
  - `status` 'in_sync' | 'modified' | 'added' | 'conflict' | 'remote_deleted' | 'pending_delete' | 'pending_rename' | 'in_review' | 'open_pr', required
  - `fromPath` string, nullable, required: Previous path of a file renamed since the last push.
  - `conflictId` string, nullable, required
  - `review` object, nullable, required
    - `state` 'awaiting' | 'approved' | 'changes_requested', required
    - `reviewerCount` integer, required
    - `isCurrentUserReviewer` boolean, required
  - `hasPendingSuggestions` boolean, required: Un-accepted suggestions block a push until resolved.
  - `canPush` boolean, required: Whether you can push this change now.

## Other responses

- `400`: Bad request, or a folder that is not the sync root
- `403`: Two-way sync is not enabled or permission is missing
- `404`: Folder not synced, or file not found

---

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