API documentation | API docs for agents | OpenAPI 3.1

status

ark.get_quickbooks_status

Returns safe QuickBooks connection health, token expiry state, realm presence, missing requirements, and integration configuration for accounting workflow decisions.

Availability: Expanded preview
Scopes: billing:read
ARK permissions: canViewBilling
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

None.

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/integrations/quickbooks/status' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

QuickBooks status

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.providerstringrequired

data.isConfiguredbooleanrequired

data.isConnectedbooleanrequired

data.activebooleanrequired

data.connectionStatestringrequired

one of: connected, not_configured, inactive, missing_credentials, needs_refresh, expired

data.needsReconnectbooleanrequired

data.requiresRefreshbooleanrequired

data.hasRealmIdbooleanrequired

data.hasAccessTokenbooleanrequired

Presence-only token indicator. Token values are never returned.

data.hasRefreshTokenbooleanrequired

Presence-only token indicator. Token values are never returned.

data.realmIdstring | nullrequired

data.accessTokenExpiresAtstring | nullrequired

format: date-time

data.refreshTokenExpiresAtstring | nullrequired

format: date-time

data.accessTokenExpiredbooleanrequired

data.refreshTokenExpiredbooleanrequired

data.accessTokenExpiresSoonbooleanrequired

data.missingRequirementsarray<string>required

data.configobject | nullrequired

data.createdAtstring | nullrequired

format: date-time

data.modifiedAtstring | nullrequired

format: date-time

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied