API ReferenceProjects

List projects

Retrieve all projects. If the parameter status=active is passed, only active projects (those where a tree can be planted) will be listed.

Query parameters

statusenumOptional

Filter projects by status. Pass active to return only plantable projects.

Allowed values:

Response

Array of project summaries.
idintegerOptional
slugstringOptional
namestringOptional
locationstring or nullOptional
descriptionstring or nullOptional
statusenumOptional

active = affiliated project where trees can be planted.

species_price_fromdoubleOptional
Lowest species price in the project.
latdouble or nullOptional
longdouble or nullOptional
imagestring or nullOptionalformat: "uri"
urlstringOptionalformat: "uri"

Front-end URL for this project.