Skip to main content

Sustainability page

A Sustainability Page represents the entity which enables accounts or client accounts to share their impact publicly.

Upon the first retirement, the Sustainability Page displays certificates with proof of the retired carbon credits and beneficiary.

  • Endpoints
    • POST
     /sustainability-pages
    PUT
     /sustainability-pages
    GET
     /sustainability-pages/current-account
    GET
     /sustainability-pages/public/{type}/{slug}
    GET
     /sustainability-pages/public/{organisation_id}/{type}/{handle}
    The Sustainability page object
    statusenumrequired

    The sustainability page status which determines whether it is visible to the public.

    Enum:
    • enabled
    • disabled
    slugstring^[a-z0-9.-]+$required

    The sustainability page slug. The slug is used to identify the page publicly and should be unique.

    titleenumrequired

    The sustainability page title stat format.

    Enum:
    • by_volume
    • by_price
    custom_descriptionstringrequired

    The sustainability page custom description. Only displayed when description is set to by_custom_description.

    The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

  • SustainabilityPage
    • {
  "status": "enabled",
  "slug": "acme",
  "title": "by_volume",
  "description": {
    "Description": "by_equivalent"
  },
  "custom_description": "This is a custom description",
  "sections": [
    "bundles_breakdown",
    "certificates"
  ]
}