Portfolio Health

Use the issue routes to monitor managed teams with a provider API key.

Cross-Team Issues

Endpoint:

• GET https://api.edge.vrplatform.app/teams/issues

Headers:

x-api-key: <provider-api-key>

Query params:

• tenantIds
  • comma-separated team ids
• codes
  • comma-separated issue codes
• includeEmptyTeams
  • boolean
  • default: false

Example:

curl 'https://api.edge.vrplatform.app/teams/issues?tenantIds=<id-a>,<id-b>&codes=brokenConnections,teamInactive' \
  -H 'x-api-key: <provider-api-key>'

One Team

Endpoint:

• GET https://api.edge.vrplatform.app/teams/{id}/issues

Headers:

x-api-key: <provider-api-key>

Optional query param:

• codes

Current Issue Codes

• teamInactive
• partnerInactive
• partnerBillingInactive
• brokenConnections
• outdatedConnections
• duplicatedPayments
• unbalancedJournalEntries
• unbalancedTransactionJournalEntries
• closedPeriodUnattachedJournalEntries
• missingOwnershipOrDeactivation
• unpaidReservations
• cancelledReservationPaidWithoutAdjustment
• publishedStatementUnpaid
• reservationPaymentProjectionMismatch
• listingOwnershipPeriodNotFoundOnActiveJournals
• reservationGuestTotalsMismatch

Response Shape

Each item contains:

• tenantId
• tenantName
• issues
• summary

Current summary fields:

• total
• affectedTotal
• errors
• warnings
• criticalToUser
• criticalToSystem

Validation Failures

Current query validation returns 400 for:

• invalid team ids in tenantIds
• invalid issue codes in codes

When To Use Which Route

Use GET /teams/issues for:

• provider dashboards
• batch monitoring
• work queues

Use GET /teams/{id}/issues for:

• one-team drilldown
• fix flows after a portfolio alert