external-platform

Get Quickbooks Status

Get QuickBooks connection status with optional health check.

When check_health=true, performs a lightweight CompanyInfo call only if the currently stored access token is still fresh. Databricks owns token refresh for UDM data-platform flows.

get/api/external-platform/quickbooks/status

Request

Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
URL: https://api.usepomo.ai/api/external-platform/quickbooks/status
Auth: HTTP bearer

Query parameters

check_healthboolean

Perform live health check

Response

Successful Response

connectedboolean required

Whether the platform is connected

healthyboolean

Whether the token is healthy (passed API check)

health_messagestring nullable

Health check result message

account_idstring nullable

Platform-specific account identifier

account_namestring nullable

Display name for the account

token_expires_soonboolean

Whether token expires within buffer period

last_health_checkstring nullable

ISO timestamp of last health check

realm_idstring nullable

QuickBooks company realm ID

company_namestring nullable

Company name from QBO CompanyInfo

Example response

{
  "account_id": "shop_12345",
  "account_name": "My Store",
  "connected": true,
  "health_message": "Token is valid",
  "healthy": true,
  "last_health_check": "2024-01-15T10:30:00Z",
  "token_expires_soon": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.