KNknownwell
clients

Get Portfolio Health

Changed on
get/v1/clients/portfolio-health

Request

Query parameters

include_archivedboolean
portfolio_idstring nullable

Scope results to a portfolio. Pass an id from GET /portfolios; omit it (or pass 'all-clients') for no scoping. An unknown, malformed or inaccessible id returns 404 rather than all clients. The camelCase spelling 'portfolioId' is accepted as an alias.

Response

Successful Response

scoreinteger required
breakdownobject required
distributionobject required
customerIdstring required
chr2CutoverDatestring nullable

CHR 2.0 cutover date if enabled

portfolioIdstring nullable

The portfolio scope that was actually applied, echoed back. Null on an unscoped response.

Changes

  • 88246c119184Revision changes
    • info

      added the new optional query request parameter portfolio_id

    • info

      added the optional property to the response with the status