clients
Search Clients
get/v1/clients/search
Query parameters
querystring required
fieldsstring[]
include_archivedboolean
limitinteger
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.
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
{"stackTrail":"paths:/v1/clients/search:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}