---
title: "QuickBooks Online connection status for the caller's workspace (no tokens)."
method: GET
path: "/v1/quickbooks/status"
tags: ["QuickBooks"]
---

# QuickBooks Online connection status for the caller's workspace (no tokens).

`GET /v1/quickbooks/status`

## Request

- Base URL: `https://signaledi.com/api`
- URL: `https://signaledi.com/api/v1/quickbooks/status`
- Auth: HTTP bearer

## Response `200`

Connection status.

- QuickBooksStatusResult
  - `ok` true, required
  - `connected` boolean
  - `realmId` string, nullable: Masked realm id (last 4).
  - `environment` string
  - `errorMessage` string, nullable
  - `connectedAt` string, date-time

## Other responses

- `401`: Missing or invalid API key (`code` AUTH_UNAUTHORIZED).
- `403`: API key lacks the required `platform` scope (`code` PLATFORM_SCOPE_REQUIRED), its lane is invalid (API_KEY_ENVIRONMENT_INVALID), the workspace is not entitled to the platform API (PLATFORM_NOT_ENTITLED), or a supplied `workspaceId` does not match the authenticated workspace (FORBIDDEN).
- `404`: Resource not found, or the /v1 platform is disabled (`code` NOT_FOUND / PARTNER_NOT_FOUND / WORKSPACE_NOT_FOUND).
- `429`: Rate limit exceeded (`code` RATE_LIMITED).
- `500`: Unexpected server error (`code` e.g. PARSE_FAILED, VALIDATE_FAILED, OUTBOUND_FAILED, INBOUND_FAILED, BATCH_FAILED, TRANSACTIONS_FAILED, DOCUMENT_RECEIPT_FAILED, DOCUMENT_PAYLOAD_FAILED). Sanitized bodies carry an opaque `correlationId` to quote to support; internal error text is never echoed.

---

[API](https://skmtc.dev/signaledi/apis/signaledi-developer-api.md) · [All operations](https://skmtc.dev/signaledi/apis/signaledi-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signaledi/apis/signaledi-developer-api/revisions/9bc596644a10?raw)