v1
latestOpenAPI 3.1.02026-07-263644911022.4 KBList Portfolios
Use this endpoint to retrieve the details of all Portfolios in your Ledger. If the filters in the request do not meet the endpoint's criteria, an empty response will be returned.
Path parameters
The unique identifier of the Organization associated with the Ledger.
The unique identifier of the associated Ledger.
Query parameters
The maximum number of items to include in the response. Max: 100
The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.
The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.
The order used to sort the results.
The number of the page that you want to retrieve.
Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).
Filter the portfolios by the unique identifier of the entity responsible for them.
Filter the portfolios by their status code.
Headers
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>
Response
Indicates that the request was successful and the response contains the expected data.