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

spaceIdinteger required

Space id, from GET /spaces.

Query parameters

pathstring

Path relative to the sync root. Pass this or fileNodeId.

fileNodeIdstring

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Response

Sync status of one file.

pathstring required

Path relative to the sync root.

repoPathstring required

Path in the repository.

fileNodeIdstring nullable required
kind'markdown' | 'text' | 'config' | 'opaque' required
documentIdstring nullable required
titlestring nullable required
status'in_sync' | 'modified' | 'added' | 'conflict' | 'remote_deleted' | 'pending_delete' | 'pending_rename' | 'in_review' | 'open_pr' required
fromPathstring nullable required

Previous path of a file renamed since the last push.

conflictIdstring nullable required
hasPendingSuggestionsboolean required

Un-accepted suggestions block a push until resolved.

canPushboolean required

Whether you can push this change now.

Changes

No recorded changes to this operation across all 1 revision of this API.