Get a worktree's sync state

GET

/api/orgs/{org}/projects/{project}/sync

const url = 'https://api.wrktr.com/api/orgs/example/projects/example/sync?branch=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.wrktr.com/api/orgs/example/projects/example/sync?branch=example' \
  --header 'Authorization: Bearer <token>'

What the daemon last reported for the branch’s worktree: in sync, stopped on a conflict, or failing to sync.

Authorizations

bearer

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

SyncStatus

application/json

object

branch

required

string

state

required

string

Allowed values: ok conflict error unknown

files

required

Array<string>

detail

required

Any of:

string
null

string

reportedAt

required

Any of:

unknown
null

Any of:

number
string

number

Example

{
  "state": "ok",
  "reportedAt": "Infinity"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}