Skip to main content
GET
/
api
/
v1
/
workspaces
/
{workspace_id}
/
sync
/
state
Get Sync State
curl --request GET \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/sync/state \
  --header 'Authorization: Bearer <token>'
{
  "synced_head_refs": [
    "<string>"
  ],
  "synced_checkpoints": [
    "<string>"
  ],
  "last_base_ref_sync_at": "2023-11-07T05:31:56Z",
  "last_base_ref_sync_ref": "<string>",
  "last_base_ref_sync_sha": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

Response

Successful Response

Current sync state for a workspace.

​
synced_head_refs
string[]
required
​
synced_checkpoints
string[]
required
​
last_base_ref_sync_at
string<date-time> | null
​
last_base_ref_sync_ref
string | null
​
last_base_ref_sync_sha
string | null