COconductor-is

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.

get/quickbooks-desktop/health-check

Request

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

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.

durationnumber required

The time, in milliseconds, that it took to perform the health check end-to-end.

status'ok' required

The status of the health check.

Example response

{
  "duration": 100,
  "status": "ok"
}

Changes

No recorded changes to this operation across all 60 revisions of this API.