external-platform

Get Square Status

Get Square connection status with optional health check.

Args: check_health: If true, perform a live API call to verify token validity

get/api/external-platform/square/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/square/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

merchant_idstring nullable

Square merchant ID

availableboolean
unavailable_reasonstring nullable
business_namestring nullable

Business name

primary_location_idstring nullable

Primary location ID

locations_countinteger

Number of locations

granted_scopesstring[]

Granted Square OAuth scopes

has_write_accessboolean

Whether the current integration includes Square write scopes

write_access_missing_scopesstring[]

Missing standard Square write scopes required for sandbox seeding

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.