Skip to main content
GET
/
api
/
v1
/
syncs
/
{id}
Get a sync
curl --request GET \
  --url https://app.sure.am/api/v1/syncs/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "in_progress": true,
    "terminal": true,
    "syncable": {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "children_count": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "window_start_date": "2023-12-25",
    "window_end_date": "2023-12-25",
    "pending_at": "2023-11-07T05:31:56Z",
    "syncing_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "error": {
      "message": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sure.am/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

​
id
string<uuid>
required

UUID of the sync to retrieve. The sync must belong to the authenticated user's family.

Response

sync shown

​
data
object
required

The sync resource, or null when no sync exists (for example, the latest sync endpoint when the family has never synced).