RevKeen Docs
Api reference

Get sync states for integration

Get all sync states for a specific integration (by provider and merchant).


Related endpoints

  • PUT /sync-state/{source}/{merchantId}/{resourceType} — Update sync state

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 403 permission_denied — key lacks the required scope, or the resource belongs to a different merchant.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/sync-state/{source}/{merchantId}
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

source*string

Integration source (e.g., practicehub, wodify)

merchantId*string

Merchant ID

Formatuuid

Response Body

application/json

curl "https://api.revkeen.com/v2/sync-state/practicehub/00000000-0000-0000-0000-000000000000" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "provider": "string",
      "resourceType": "string",
      "lastSyncAt": "2019-08-24T14:15:22Z",
      "lastSyncStatus": "idle",
      "lastSyncError": "string",
      "cursor": "string",
      "itemsSynced": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Empty
Empty