Projects

The Product Projects endpoint retrieves the list of environmental projects linked to a given product. These projects are defined during organisation onboarding and can be displayed to customers to help them choose where to direct their contribution.

ℹ️

See the API reference for example payloads.

What it does

• Returns all projects set up in your organisation's portfolio with descriptions, logos, URL and other information

Key fields explained

• projectId → unique identifier for the project
• name → project name to display to customers
• logo → URL of the project’s logo for use in your UI
• description → short explanation of the project
• projectUrl → link to the project’s webpage for more detail
• unitType → what one unit represents (e.g., “kg CO₂e reduced”, “tree planted”)
• unitPrice → cost of one unit in the product’s currency

Best practices

• Show project details clearly so customers understand their impact
• Use logo and description to create an engaging, trustworthy experience
• Default to your configured portfolio, but allow project-level selection if your customer journey supports it