---
title: "Get accounting synchronization settings"
method: GET
path: "/external-syncs/settings"
tags: ["External Sync"]
---

# Get accounting synchronization settings

`GET /external-syncs/settings`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/external-syncs/settings`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-api-reference/docs/external-syncs/settings/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the active accounting platform and its synchronization state.

Use this endpoint to check whether a platform is connected, whether a synchronization is currently running, and why the most recent synchronization failed.

## Response `200`

The connected accounting platform and its synchronization state.

- ExternalSyncStatus
  - `platform` 'quickbooks_online' | 'netsuite' | 'null', nullable, required: The connected accounting platform, or `null` when no platform is connected.
  - `status` 'disconnected' | 'idle' | 'syncing' | 'failed', required: The current synchronization state: - `disconnected` - no accounting platform is connected. - `idle` - a platform is connected and no synchronization is running. - `syncing` - a synchronization is currently in progress. - `failed` - the most recent synchronization failed. See `error` for details.
  - `last_sync_started_at` string, date-time, nullable, required: When the most recent synchronization started, or `null` if none has run.
  - `last_sync_completed_at` string, date-time, nullable, required: When the most recent synchronization finished, or `null` if none has completed.
  - `progress` number, nullable, required: Percentage of the in-progress synchronization that has completed. Only reported for QuickBooks Online; `null` for other platforms.
  - `error` object, nullable, required: Details of the most recent failure. Only set when `status` is `failed`, otherwise `null`.
    - `message` string, required: A short string describing why the synchronization failed.

## Other responses

- `401`: Unauthorized error
- `403`: The access key lacks the permission required for this request.

---

[API](https://skmtc.dev/resolvepay/apis/resolve-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-api-reference/revisions/c62edc454aaa?raw)