Skip to main content
GET
/
api
/
v1
/
syncs
List sync history
curl --request GET \
  --url https://app.sure.am/api/v1/syncs \
  --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>"
      }
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

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.

Query Parameters

page
integer

Page number (default: 1)

per_page
integer

Items per page (default: 25, max: 100)

Response

syncs listed

data
object[]
required
Maximum array length: 100
meta
object
required