Overview

This guide explains how to check the sync status of a Linked Account's integrations, both from the Merge Dashboard and via the Merge API.

What is sync status?

Sync status reflects the current state of each Common Model for a given Linked Account. Merge surfaces sync status per Common Model so you can confirm data is up to date before reading from the API. The possible status values are SYNCING, DONE, FAILED, DISABLED, PAUSED, and PARTIALLY_SYNCED.

How to check sync status in the Merge Dashboard

1. From your Merge Dashboard, navigate to Linked Accounts.

2. Click the Linked Account you'd like to check.

3. Review the status surfaced for each Common Model on the account's detail page.

How to check sync status via the API

You can also retrieve sync status programmatically by sending a GET request to the /sync-status endpoint for the appropriate category base URL. The response returns the status of each Common Model for the Linked Account. See a sample response in the Merge Developer Docs.

When should I call /sync-status?

Call /sync-status before pulling data to ensure you're reading complete data from Merge.