Skip to main content
GET
/
v1
/
portfolios
Get Portfolios
curl --request GET \
  --url https://api.example.com/v1/portfolios
[
    {
        "name": "Example Portfolio",
        "carbon_portfolio_summary": "Example Portfolio Summary",
        "carbon_portfolio_description": "Example Portfolio Description"
        "carbon_portfolio_image_url": "https://example.com/",
        "carbon_provider": {
            "name": "Example Provider",
            "website": "https://example.com/"
        }
    }
]

​
Headers

​
api-key
string
required
Authorisation requires an API key in the header of the request. Please see this page for more information.

​
Response Fields

​
name
string
The name of the portfolio.
​
carbon_portfolio_summary
string
The summary of the portfolio.
​
carbon_portfolio_description
string
The description of the portfolio.
​
carbon_portfolio_image_url
string
The image of the portfolio. This field is nullable.
​
carbon_provider
object
[
    {
        "name": "Example Portfolio",
        "carbon_portfolio_summary": "Example Portfolio Summary",
        "carbon_portfolio_description": "Example Portfolio Description"
        "carbon_portfolio_image_url": "https://example.com/",
        "carbon_provider": {
            "name": "Example Provider",
            "website": "https://example.com/"
        }
    }
]