KNknownwell
clients

List Clients

Changed on
get/v1/clients

Request

Query parameters

include_archivedboolean
limitinteger
offsetinteger
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

totalinteger required
customerIdstring required
portfolioIdstring nullable

The portfolio scope that was actually applied, echoed back. Null on an unscoped response, including when 'all-clients' was requested.

Changes

  • 88246c119184Revision changes
    • info

      added the new optional query request parameter portfolio_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status