API Reference
Log In
API Reference

Projects

With the project endpoints you can see the project categories and the corresponding projects.

ProjectCategory Object

PropertyTypeDescription
projectCategoryIdstringThe unique identifier of the project category.
namestringThe name of the project category.
descriptionstringDetailed explanation of what the project category is. It provides more context for users who want to understand the category.
typestringDefines the type of environmental impact associated with projects in this category. Type can be trees, plastic or carbon.
imagesProjectCategoryImage[]Images associated with the project category. They help users visualise the impact of the project category.

ProjectCategory Object

PropertyTypeDescription
stylestringThe url of the project category image.
imageUrlstringThe style of the image, can be flat, simplified or 3d.

Project Object

PropertyTypeDescription
projectIdstringThe unique identifier of the project.
projectCategoryIdstringDefines the category that the project falls under. It links the project to its relevant category.
namestringThe name of the project.
descriptionstringDetailed explanation of what the project is about. It provides more context for users who want to understand the project.
typestringRefers to the type of impact that the project is expected to have. Type can be trees, plastic or carbon.
registryLinkstringThis is a link to a webpage where users can find more detailed information about the project.
imageUrlstringLink to an image representing the project.
countriesstring[]List of countries where the project's activities are taking place.
pricenumberDefines how much it costs to purchase one unit of impact in the account's currency.
availabilitynumberDefines how many units of impact are still available for purchase through the project. If there's no limit, this is null. For a carbon offsetting project, this would be the number of tonnes of carbon that can still be offset through the project.