Home / Help / API Sync help
Datplan help

API Sync help

Connect supported sources, refresh company data, understand full pulls, and use incremental pulls where supported.

API SyncAPI SchedulerAPI DashboardUsage limitsStar-schema exportsTroubleshooting

Help topics

Clear product guidance for setup, syncs, schedules, dashboards, exports, usage, and support.

1Choose source
2Choose company
3Click pull

API sync workflow

API Sync is the main area for refreshing data from supported business systems. The intended workflow is simple: choose a workspace, choose a source, choose the company or connected account, then run the pull.

  1. Open API Pull.
  2. Select the workspace that should hold the refreshed data.
  3. Select a supported source such as Xero or HubSpot.
  4. Connect or choose the provider account.
  5. Run a standard sync, or use a full re-pull when needed.

Full pulls and incremental pulls

A full pull rebuilds or reloads the selected source data. An incremental pull refreshes from the last saved pull position or checkpoint where that behaviour is supported by the provider and endpoint.

Allowance note: incremental pulls may reduce Datplan tier allowance usage and provider allowance consumption, but they are still subject to tier allowances, provider limits, and usage already consumed by other apps connected to the same provider tenant.

Frequently asked questions

How do I connect a source?

Go to API Pull, select a workspace, select a source, then click Connect account. The provider sign-in opens in your browser. Complete sign-in and consent, then return to Datplan DataPull. Once the connection is confirmed, the account can be selected and synced.

Does Datplan show provider passwords inside the app?

No. Provider sign-in is completed through the provider’s own browser-based sign-in process.

What is a sync?

A sync refreshes data from the selected source and account. The sync page shows progress, downloaded volume, endpoint results, last sync details, and any notes that may need attention.

When should I use Re-pull all data?

Use Re-pull all data only when local data appears stale, incomplete, or support advises a full rebuild. For normal use, run a standard sync.

What are incremental pulls?

Incremental pulls use the last saved pull position or checkpoint where supported by the source provider and endpoint. This can reduce Datplan tier allowance usage and provider allowance consumption compared with repeated full pulls.