Jump to Content
Greenspark
API Reference
Log InGreenspark
API Reference
Log In
API Reference

Greenspark API

  • Introduction
  • How it works
  • SDKs

Overview

  • Terminology
  • Environments
  • Authentication
  • Errors
  • Pagination
  • Metadata
  • Timestamps
  • Impact segmentation

Impact

  • Impacts
    • Create Impactpost
    • Create Tailored Impactpost
    • Create Impact in Batchpost
    • Fetch Impact Purchasesget
    • Fetch Impact Purchaseget

Projects

  • Projects
    • Fetch project categoriesget
    • Fetch projectsget
    • Fetch project by idget

Estimations

  • Estimations
    • Fetch Carbon Estimate of a Transaction by MCCpost
    • Fetch Carbon Estimate of Multiple Transactions by MCCpost
    • Fetch Carbon Estimate of a Transaction by Open Banking Category Typespost
    • Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Typespost

Reporting

  • Reports
    • Fetch Raw Report v2get
    • Fetch Raw Reportget
    • Fetch a Report Pageget
    • Fetch Total Impact By Type Reportget
    • Fetch Impact Amount By Type Per Source Reportget
    • Fetch Impact Amount By Type Per Trigger Reportget
    • Fetch Carbon By Intervalget
    • Fetch Plastic By Intervalget
    • Fetch Trees By Intervalget
    • Fetch Impacts By Intervalget
    • Fetch Total Impact By Sourcesget
    • Fetch Total Impact By Triggersget
    • Fetch Total Spend On Impactsget
    • Fetch Average Spend Per Impactget
    • Fetch Total Impacts Countget

Email

  • Email
    • Fetch Domainsget
    • Add Domainpost
    • Verify Domainpost
    • Delete Domaindelete
    • Fetch Templates Defaultsget
    • Fetch Templatesget
    • Add Templatepost
    • Update Templateput
    • Delete Templatedelete
    • Test Templatepost

Widget API

  • Localisation
  • Widgets
    • Spend level widgetpost
    • Spend level widget v2post
    • Per order widgetpost
    • Per order widget v2post
    • By percentage widgetpost
    • By percentage widget v2post
    • By percentage of revenue widget v2post
    • Tiered spend level widgetpost
    • Tiered spend level widget v2post
    • Per product widgetpost
    • Per product widget v2post
    • Cart widgetpost
    • Cart widget v2post
    • Top stats widgetpost
    • Top stats widget v2post
    • Full width bannerpost
    • Full width banner v2post

Account Management

  • Account
    • Public Accountget
Powered by 

SDKs

You can use the following SDK's to interact with the Greenspark API:

Typescript

  • @getgreenspark/reports
  • @getgreenspark/impacts
  • @getgreenspark/estimations
  • @getgreenspark/email
  • @getgreenspark/projects
  • @getgreenspark/widgets

For more information please check the GitHub repository.