---
title: "Health check"
method: GET
path: "/quickbooks-desktop/health-check"
---

# Health check

`GET /quickbooks-desktop/health-check`

Checks whether the specified QuickBooks Desktop connection is active and can process requests end-to-end. This is useful for showing a "connection status" indicator in your app. If an error occurs, the typical Conductor error response will be returned. As with any request to QuickBooks Desktop, the health check may fail if the application is not running, the wrong company file is open, or if a modal dialog is open. Timeout is 60 seconds.

## Headers

- `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request.

## Response `200`

Returns an object with the duration of the health check in milliseconds. If the health check fails, returns the standard Conductor error response. For end-user UI, prefer `error.userFacingMessage`; use `error.message` for logs, developer/admin surfaces, and test projects.

- object
  - `duration` number, required — The time, in milliseconds, that it took to perform the health check.
  - `status` 'ok', required — The status of the health check.

---

[API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)