Skip to main content
GET
Get Portfolio By Id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the portfolio to return

Example:

"oH5hlq"

Response

Portfolio Details

Details about a portfolio, including the allocations of the portfolio to project categories, as well as price info.

id
string

Identifier that can be used to retrieve the portfolio

Example:

"Fc35bt3"

name
string

Name of the portfolio

Example:

"Climate Active"

summary
string

Short description of the portfolio

Example:

"Portfolio of climate active eligible projects"

description
string

Extended description of the portfolio

Example:

"This is a portfolio that only includes projects eligible for Climate Active designation"

primary_image_url
string | null

URL for the primary image of the portfolio

Example:

"https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg"

checkout_price_per_kg_usd_cents
number

Price per kilogram of carbon credits when purchasing through the Checkout Session API or the Web Dashboard, in USD cents. Note that while this can be a decimal number like 1.6, a Checkout Session API or Web Dashboard order price will always be rounded up to an integer number of cents.

Examples:

2

1.6

api_price_per_kg_usd_cents
number

Price per kilogram of carbon credits when purchasing through the Order API, in USD cents.

Examples:

2

1.6

category_allocations
object[]

The list of project category allocations in the portfolio.