{"info":{"_postman_id":"4ee4be93-f4cd-474c-b9bc-5ef941c9065a","name":"Tree-Nation API","description":"

The following case study explains one potential use of the API including 2 levels of interactions: a SAAS platform and the end-users of the SAAS.

Two levels

Level 1 - The API user.
In this case study, the API user is a SAAS platform that wants to include trees as a gamification mechanism within its platform. The SAAS platform is connected to the Tree-Nation API in order to add the Tree-Gift reward system to its platform.

Level 2 - End-Users
The SAAS platform provides access to the SAAS to their employees/clients, who are the real users of the SAAS service. The end-users are the Tree-Gift recipients that are rewarded with them in function of their actions on the SAAS platform.

Invoicing

To pay for the trees it was defined that:

Tree-Nation would only be invoicing the API user, not the tree-gift recipients. This allows avoiding additional approval processes from the clients to receive the gift at Tree-Nation.
\n
The API user uses his 'tree credits' to pay for the client's gifts. This automatically generates a new tree for every client making a specific action.
\n

Let's see an example:

Your company requests a pack of 1000€ tree credits. Then the SAAS Platform user subscribes or makes a purchase through your platform (you make the decision of what triggers a tree gift). With that action, your client/employee receives a tree gift from your company, and the tree price is deducted from your 1000€ credits.

Invoices are paid by bank transfer. The period to pay the invoices can be adjusted to fit your company.

Tree creation

The main function of the API is to trigger/create a tree. When triggered, the API gives back a unique tree URL, which can be passed on to the end-user and serve as proof of planting and its own tree certificate.

Each Tree-Gift URL allows its recipient to collect the tree on Tree-Nation and have its own forest.

As part of the initial API configuration, it is decided if Tree-Nation sends its standard tree-gift email to the end-user or if this emailing task is taken care of by the API user. If Tree-Nation is tasked to send the emails, the recipient’s name and email can be passed through the API.

Each tree creation draws from the tree credits and will be limited to the availability of credits.

In this 2-levels configuration, each tree is linked to 2 forests: the corporate client forest (seen as the one gifting the tree) and the end-user forest (seen as the one receiving the tree).

All the trees are thus visible in the SAAS platform forest.
\n
Each client has as many trees as they order, under your forest (the gifting company) and his forest as well (the recipient).
\n

Content

The API also provides the API user with a series of content that can be directly included in the SAAS platform. This include:

Detailed species information.
\n
Project information.
\n
Tree and CO2 counters for any given forest (the SAAS platform forest or the End-user forest).
\n
Updates from the field (easy-to-read quick posts and longer articles, both with photographs).
\n

Those updates can be requested in 3 different ways:

All project updates.
\n
All updates related to a single project.
\n
All updates related to a single forest (the SAAS platform forest, Corporate forest, or End-user forest).
\n

We keep improving it

Our API is built to be the ultimate gamification tool. We will make sure that it fits your configuration requirements and plan to keep developing its functionalities in the function of our client's feedback. So please do not hesitate to ask us for new features that would make sense for your business, we’ll try very hard to make it happen!

Need any assistance?

Please contact us at support@tree-nation.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14383592","collectionId":"4ee4be93-f4cd-474c-b9bc-5ef941c9065a","publishedId":"2sAYJ98xqX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-03T10:10:55.000Z"},"item":[{"name":"Plant and Offer Trees / Species package","item":[{"name":"Plant trees","id":"031b5e7b-9639-4d0f-b1d6-8f4ea017e84b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"quantity\": 1, //Number of trees you want to plant per trigger (i.e: Set this to 5 if your customer buys 5 tshirts in the checkout)\r\n\t\"message\": \"Thank you for planting trees at our side!\" //message under the tree image (optional, the message displayed under the tree)\r\n\r\n}"},"url":"{{url}}/api/plant","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"f34c97b4-1c72-409c-a59b-b3140954f200","id":"f34c97b4-1c72-409c-a59b-b3140954f200","name":"Plant and Offer Trees / Species package","type":"folder"}},"urlObject":{"path":["api","plant"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ae545700-c217-43b4-acda-16ba262eba4c","name":"Plant trees","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"quantity\": 1,\r\n\t\"message\": \"Thank you for planting trees at our side!\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://tree-nation.com/api/plant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 22 Feb 2019 13:57:40 GMT"},{"key":"Server","value":"Apache/2.4.23 (Win32) PHP/7.1.11"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.11"},{"key":"Cache-Control","value":"no-cache"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlZ6K3dcL0JXbWFrczhcL1wvMzRTVmtNVnc9PSIsInZhbHVlIjoielRFWUZ2d1wvWEVoNnZWR3NzU21LVnpxWWtjWWQ2RzJ3QjZYdUFrSXNUbDMwaGYyMmdiS2I2bTVkZEtmaVM1TU1zT1phZGc3UGZKUERNbG5TeG5kNTB3PT0iLCJtYWMiOiIwNGJiNDAxZGNhOGFjOWI3NjYwMDc3NzRmNmVlYmJkZjI5MGI2ODY3YjM3MDM2NTcxNDk5NmIwMGUyYzU2NmNjIn0%3D; expires=Fri, 22-Feb-2019 15:57:50 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkpRU2J1UzJkamxkTDcxdVwvUDdGKzJBPT0iLCJ2YWx1ZSI6IkpkaWEwWnY0eXN3dmhiXC9MMElFTldZa21xeFVua0RXa2pIMFJURWdjV3dkMHBUa0h1MTB4RVlBXC9KdVRXWFBvdjBud0ZZMmVDcjlHaEwzVk5DbmdheUE9PSIsIm1hYyI6ImUyY2U5NjVmYTFjNDRjNzYyMTZjZTQzZWQwOGRiNzhjMDliNTJhN2I3MzVjNWM0Nzg2NTU3YzY5ZWZlNjdiMzAifQ%3D%3D; path=/; HttpOnly"},{"key":"Content-Length","value":"411"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"trees\": [\n {\n \"id\": 8693230,\n \"internal_id\": null,\n \"token\": \"f0c3b76a9cab964d\",\n \"collect_url\": \"https://tree-nation.com/collect/f0c3b76a9cab964d\",\n \"certificate_url\": \"https://tree-nation.com/certificate/f0c3b76a9cab964d\",\n \"country\": \"Tanzania\",\n \"project_id\": 269,\n \"project_name\": \"Replanting the burnt Mkussu Forest\",\n \"project_url\": \"https://tree-nation.com/projects/replanting-the-burnt-mkussu-forest/updates\",\n \"species_id\": 2924,\n \"species_name\": \"Prunus africana\",\n \"species_life_time_CO2\": 50\n }\n ],\n \"payment_id\": 5730995\n}"}],"_postman_id":"031b5e7b-9639-4d0f-b1d6-8f4ea017e84b"},{"name":"Offer trees","id":"9662c04e-262b-4051-a322-dc2fe7c11131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"recipients\": [ //recipient's information. Name and email is optional. In case not provided, internal_id is helpful.\r\n\t\t{\r\n \"internal_id\": 12345, //The user_id of the tree-gift recipient in your database. \r\n\t\t\t\"name\": \"test user\", //The name of the tree-gift recipient in your database.\r\n\t\t\t\"email\": \"test875349@test.com\" //The email of the tree-gift recipient in your database.\r\n\t\t},\r\n\t\t{\r\n \"internal_id\": 12346,\r\n\t\t\t\"name\": \"test user2\",\r\n\t\t\t\"email\": \"test458954@test.com\"\r\n\t\t}\r\n\t\t\r\n\t],\r\n \"quantity\": 1, //Number of trees you want to plant per trigger (i.e: Set this to 5 if your customer buys 5 tshirts in the checkout)\r\n \"language\": \"en\", //One of: 'en', 'es', 'fr', 'it'. The language of the email sent to the tree-gift recipient\r\n \"message\": \"thank you for planting trees at our forest!\" //message under the tree image (optional, the message your tree-gift recipient will read when collecting their tree-gift)\r\n\r\n}"},"url":"{{url}}/api/plant","description":"

recipients (optional). Array of recipients. Each recipient can have these properties:
\n
- internal_id (optional) - id of the user in your own database
  \n
- name (optional) - Display the recipient’s name on the tree and certificate before collection
  \n
- email (optional) - Email of the recipient. Put your account email address if you want to plant the tree instead of offering it.
  \n
- quantity (optional) - Quantity of trees per recipient
  \n
- language (optional) - One of: 'en', 'es', 'fr', 'it' (default = en)EndFragment
  \n
  At least internal_id or name is required. If it's omitted, the system will create an anonymous recipient for the tree (without name or email).
  \n
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"f34c97b4-1c72-409c-a59b-b3140954f200","id":"f34c97b4-1c72-409c-a59b-b3140954f200","name":"Plant and Offer Trees / Species package","type":"folder"}},"urlObject":{"path":["api","plant"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3fa29a7e-41e9-4d42-b79a-68dc747e0ec1","name":"Offer trees","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"recipients\": [\n\t\t{\n\t\t\t\"name\": \"test user\",\n\t\t\t\"email\": \"test875349@test.com\"\n\t\t}\n\t],\n \"quantity\": 1,\n \"language\": \"en\",\n \"message\": \"thank you for planting trees at our forest!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://tree-nation.com/api/plant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 22 Feb 2019 13:57:40 GMT"},{"key":"Server","value":"Apache/2.4.23 (Win32) PHP/7.1.11"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.1.11"},{"key":"Cache-Control","value":"no-cache"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlZ6K3dcL0JXbWFrczhcL1wvMzRTVmtNVnc9PSIsInZhbHVlIjoielRFWUZ2d1wvWEVoNnZWR3NzU21LVnpxWWtjWWQ2RzJ3QjZYdUFrSXNUbDMwaGYyMmdiS2I2bTVkZEtmaVM1TU1zT1phZGc3UGZKUERNbG5TeG5kNTB3PT0iLCJtYWMiOiIwNGJiNDAxZGNhOGFjOWI3NjYwMDc3NzRmNmVlYmJkZjI5MGI2ODY3YjM3MDM2NTcxNDk5NmIwMGUyYzU2NmNjIn0%3D; expires=Fri, 22-Feb-2019 15:57:50 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkpRU2J1UzJkamxkTDcxdVwvUDdGKzJBPT0iLCJ2YWx1ZSI6IkpkaWEwWnY0eXN3dmhiXC9MMElFTldZa21xeFVua0RXa2pIMFJURWdjV3dkMHBUa0h1MTB4RVlBXC9KdVRXWFBvdjBud0ZZMmVDcjlHaEwzVk5DbmdheUE9PSIsIm1hYyI6ImUyY2U5NjVmYTFjNDRjNzYyMTZjZTQzZWQwOGRiNzhjMDliNTJhN2I3MzVjNWM0Nzg2NTU3YzY5ZWZlNjdiMzAifQ%3D%3D; path=/; HttpOnly"},{"key":"Content-Length","value":"411"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"trees\": [\n {\n \"id\": 8693230,\n \"internal_id\": null,\n \"token\": \"f0c3b76a9cab964d\",\n \"collect_url\": \"https://tree-nation.com/collect/f0c3b76a9cab964d\",\n \"certificate_url\": \"https://tree-nation.com/certificate/f0c3b76a9cab964d\",\n \"country\": \"Tanzania\",\n \"project_id\": 269,\n \"project_name\": \"Replanting the burnt Mkussu Forest\",\n \"project_url\": \"https://tree-nation.com/projects/replanting-the-burnt-mkussu-forest/updates\",\n \"species_id\": 2924,\n \"species_name\": \"Prunus africana\",\n \"species_life_time_CO2\": 50\n }\n ],\n \"payment_id\": 5730995\n}"}],"_postman_id":"9662c04e-262b-4051-a322-dc2fe7c11131"}],"id":"f34c97b4-1c72-409c-a59b-b3140954f200","description":"

Authorization is required using bearer token authentication header:

Authorization: Bearer {token}

Plant or offer a tree in your forest.

To plant a tree, the request does not need a body. If you want to plant more than 1 tree, or set a different message per trigger, you can define so through the body.
\n
To offer a tree, you can add one or an array of recipients, with their correspondng name and email.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"89eac1d0-a9f1-4df4-8818-6cd15600c136"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"52c23d41-670a-4ec9-8613-772fff17155e"}}],"_postman_id":"f34c97b4-1c72-409c-a59b-b3140954f200"},{"name":"Database","item":[{"name":"Forest counter","item":[{"name":"Forest tree counter","id":"38d3e742-7137-4bae-be73-9aaef13afe7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/forests/maxime-renaudin/tree_counter/month","description":"

Retrieve a user forest tree count (by slug)

Period is optional and can be one of: day, week, month, quarter, year

If period is not passed, the all time value will be returned

\n","urlObject":{"path":["api","forests","maxime-renaudin","tree_counter","month"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c7a593dd-0b62-4e2c-9053-c1ee51aed3c7","name":"Forest tree count daily","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/forests/maxime-renaudin/tree_counter/day"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Fri, 15 May 2020 15:59:06 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlI0U0ZyZmdsYU5NN1Q1ZkZ6bTRLaHc9PSIsInZhbHVlIjoiVStzZXlsYzB4eWlGMVFuZWRRZWhzNHZ5Q0kweWJZK0ZmNmxcL2FJXC9wcUVJOVdqcnpOR2xUSXpDSlNETktybkRXMGVuSjZxZWxMN1lIbXh4VFwvUmNqSVE9PSIsIm1hYyI6IjI5M2QyZjMyY2JiZWI0YjFjNjE1ZjA1MDU2YWU2ZjFhNmVkZTYwMmM1NzVkMjYzNGMwM2JiYTMzMGViZDcxNjEifQ%3D%3D; expires=Fri, 15-May-2020 17:59:06 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IloyWGJ5WUhHU0Z3MlJTMTloV1dUbUE9PSIsInZhbHVlIjoia2RmYTVNeGdOOCt2OENCUnFGS1wvRnRtdzhVNE1XVXpNQUNqNVBoV08rV0RnSmo3K2NcL3p5OTg0cE0xWUxwaTd3dlJwUXFRVHd2RmdsMlJ0ZmU4cUxMUT09IiwibWFjIjoiZjgwYjQ2OWE1MzYzODQyNjFmYTAzN2E1ZmIzMDRkZDc2YzQ2YTQzM2ZmMzIxNjQ0OTI2ODYzMzc2YTVlM2I2MCJ9; path=/; HttpOnly"},{"key":"Expires","value":"Fri, 15 May 2020 15:59:06 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"12"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"count\":31}"},{"id":"55f048d6-2391-4ea6-a920-0fe199a0afe2","name":"Forest tree count weekly","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/forests/maxime-renaudin/tree_counter/week"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Fri, 15 May 2020 15:59:06 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlI0U0ZyZmdsYU5NN1Q1ZkZ6bTRLaHc9PSIsInZhbHVlIjoiVStzZXlsYzB4eWlGMVFuZWRRZWhzNHZ5Q0kweWJZK0ZmNmxcL2FJXC9wcUVJOVdqcnpOR2xUSXpDSlNETktybkRXMGVuSjZxZWxMN1lIbXh4VFwvUmNqSVE9PSIsIm1hYyI6IjI5M2QyZjMyY2JiZWI0YjFjNjE1ZjA1MDU2YWU2ZjFhNmVkZTYwMmM1NzVkMjYzNGMwM2JiYTMzMGViZDcxNjEifQ%3D%3D; expires=Fri, 15-May-2020 17:59:06 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IloyWGJ5WUhHU0Z3MlJTMTloV1dUbUE9PSIsInZhbHVlIjoia2RmYTVNeGdOOCt2OENCUnFGS1wvRnRtdzhVNE1XVXpNQUNqNVBoV08rV0RnSmo3K2NcL3p5OTg0cE0xWUxwaTd3dlJwUXFRVHd2RmdsMlJ0ZmU4cUxMUT09IiwibWFjIjoiZjgwYjQ2OWE1MzYzODQyNjFmYTAzN2E1ZmIzMDRkZDc2YzQ2YTQzM2ZmMzIxNjQ0OTI2ODYzMzc2YTVlM2I2MCJ9; path=/; HttpOnly"},{"key":"Expires","value":"Fri, 15 May 2020 15:59:06 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"12"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"count\":217}"},{"id":"c745805c-165e-4120-b04b-c7e325d56825","name":"Forest tree count (all time)","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/forests/maxime-renaudin/tree_counter"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Fri, 15 May 2020 16:00:43 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6ImZhN0NHc0w1RnkxeEtPS2gxOUdtVUE9PSIsInZhbHVlIjoidDR3RUJEUTFYQzg0STVXT3pydUdNSVcrSTl3emlWa2h4N3o3NFhSNEZqM1lxenZJVHRDeDdpZ0w3OFdQb2NVck1UenUydnZmMDVNU200ZGc1VXg3V2c9PSIsIm1hYyI6IjZhMDIzNGM4OTMxY2QzYTAwYWVkOGYwZTU2YjM5NzA3M2I1MjA0NDY1YTNiYTFmNDJlZjM3MzY1ZTNjNDYwZmEifQ%3D%3D; expires=Fri, 15-May-2020 18:00:43 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InJUWHdZOWVwc2tJM2g1bHRhRHZvWGc9PSIsInZhbHVlIjoiYkNxSG1JSHRVWEw2OEFlU0xYYktQUUVrcGN5U01YVUZJa2NQc2pHQjBPeVF0XC84YzZWaG1DREd0YlMzSlwvQ05qRFJGemNnV1RJclpcL1NLR3VjM3Y0UFE9PSIsIm1hYyI6ImQ0NzI0Y2FjZDk2ZWY1ZDNjYjc4MDljNmJkYzdhNmJjNWE3Y2VlZmVlYTZkMGNjMGY4OGIxNmQzZWZiMWJlN2QifQ%3D%3D; path=/; HttpOnly"},{"key":"Expires","value":"Fri, 15 May 2020 16:00:43 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"14"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\"count\":5731}"}],"_postman_id":"38d3e742-7137-4bae-be73-9aaef13afe7f"},{"name":"Forest details","id":"324cb4f7-3adc-4850-a292-d9d6a2f59134","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/forests/32","description":"

Retrieve a user forest details

\n","urlObject":{"path":["api","forests","32"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"39dd00e0-aabd-4e7d-b87b-cc0f56ea3865","name":"Forest details","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/forests/32"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Feb 2019 14:40:13 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjMzdnFOczZNUVFnYmk0cGh0RHFvMnc9PSIsInZhbHVlIjoidUhXUWh6QzFKSXZPanJpYTdURHlhVjJJQytRSjFOVlAySG9QM09rQjNIbjJ4SjVnZUNXK3puTDdsSTcrMkxmRVJDMTZZOFd6YzlYeU9nYTFWeXVZaFE9PSIsIm1hYyI6IjZkNGQ4MDAxM2UxY2FlZjNkN2Q4YWJkMjA0M2ZkZDI0ODY0MDVkYWZhN2RjYWI0NmRkNmIwZTExMjJiNjIzZmYifQ%3D%3D; expires=Thu, 28-Feb-2019 16:40:14 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImZJN0EwUm9zUVBMcmlPaDZITXdEeWc9PSIsInZhbHVlIjoid2tJM3h5TVk3OWoyYzRNVG5EYUdubVJtbkk4V0E1SjI1WjQrbEY3XC9XYTlWaWlIVGJENWJJcHFsK1BDOGF4ZGJobzByQlYwWVU3ZWY5Y0FWSFlZZVlnPT0iLCJtYWMiOiJhYzVlZjMxZTY3NWU1MmZlMjY5YWEyNGMzMGFmMzg2ZDA2ZGY5MjY1NDY4MTdhZjFhMDQ5NDIwNTJkNjE3NWZkIn0%3D; path=/; HttpOnly"},{"key":"Expires","value":"Thu, 28 Feb 2019 14:40:13 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"54"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 32,\n \"co2_compensated\": 394.89,\n \"tree_count\": \"1525\"\n}"}],"_postman_id":"324cb4f7-3adc-4850-a292-d9d6a2f59134"}],"id":"ba8dcadd-e9cd-4d98-8e90-2e15a6b8e047","description":"

Impact data & counters

Each Tree-Nation account has a public forest page that includes an Impact tab showing environmental impact such as total trees planted, CO₂ compensated, and impact evolution over time.
If your goal is to display or share impact information, this built-in view is the recommended approach.

If you do not have access to the Tree-Nation account, ask the account owner or your Tree-Nation contact to provide the forest page link.

For simple embedding needs, you can also use Tree Counter smart labels (see Knowledge Base).

The API exposes impact counters for advanced or programmatic use cases only, such as internal reporting or data aggregation.
The API is not intended to recreate the Tree-Nation Impact Page.

Forest tree counter

Retrieve the number of trees planted in your forest over a given time period.

Available time aggregations:

/year
\n
/quarter
\n
/month
\n
/day
\n

If no time parameter is provided, the total count for the forest is returned.

Example response

{ \"count\": 28343 }\n\n

Forest details

Retrieve aggregate impact data for your forest, including:

Total trees planted
\n
Total CO₂ compensated (in tonnes)
\n

This endpoint returns numerical values only and does not include visualization or presentation logic.

\n","_postman_id":"ba8dcadd-e9cd-4d98-8e90-2e15a6b8e047"},{"name":"Updates (RSS)","item":[{"name":"All updates","id":"d4f4e423-d287-4751-9a6d-b5596623b042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/rss/updates","urlObject":{"path":["rss","updates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4f4e423-d287-4751-9a6d-b5596623b042"},{"name":"Project updates","id":"faac56f2-4560-40b4-961a-2de38a236464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/rss/projects/{slug}/updates","urlObject":{"path":["rss","projects","{slug}","updates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"faac56f2-4560-40b4-961a-2de38a236464"},{"name":"Forest updates","id":"eeade732-a6ec-42bc-9f5a-3f639f0980b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/rss/profile/{slug}/updates","urlObject":{"path":["rss","profile","{slug}","updates"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eeade732-a6ec-42bc-9f5a-3f639f0980b9"}],"id":"f9274757-e28a-472e-be0b-ab56771b6f95","description":"

Obtain project updates through RSS.

All updates

Obtain all our projects' recent updates.

Project updates

Obtain a specific project's updates

Forest updates

Obtain all projects' updates that received a contribution from a specific company.

\n","_postman_id":"f9274757-e28a-472e-be0b-ab56771b6f95"},{"name":"Project information","item":[{"name":"Project list","id":"cd1c24a2-b231-4446-9bec-7d0cf7f6e31c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/projects?status=active","description":"

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

\n","urlObject":{"path":["api","projects"],"host":["{{url}}"],"query":[{"key":"status","value":"active"}],"variable":[]}},"response":[{"id":"b7840a16-900e-4188-9a56-90b6ad36eb55","name":"Project list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://tree-nation.com/api/projects?status=active","protocol":"https","host":["tree-nation","com"],"path":["api","projects"],"query":[{"key":"status","value":"active"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Feb 2019 18:06:47 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlZrOTZibUxPYjBYbkJIRWpRSXZYbWc9PSIsInZhbHVlIjoiejdHaUhXOTl2dVwvR2dOZzR1ZjBWTlhRckcwcDlHdVc1Q1VUcjBNS2hFNStzZ3dHU1V0UUNtcWp3VytiOGNxZEhMY2h2aEVxSG9ZXC90cWhqRFBxMDJuUT09IiwibWFjIjoiNGJmNDNiNWRmMmM1NWM1ZGY4YjliMzgyNGQ1ODBlMzVjYmQ0Nzg5Njg1ZjE3MjUwOTg0NTIyNDBlYjE0OTY3YyJ9; expires=Tue, 12-Feb-2019 20:06:47 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImR4Q3d0Q1hSNDNpdTVmT1lTZ00xaHc9PSIsInZhbHVlIjoiRlFTNzN1Vk42N0xUTkUyZGFcL1NrY2R5QlwvWE9oTkVLeWtUNnhNcXgxT3FOU2M0S2xDUmdjcnBZeXp3V0hPdkFKVFFhdHlRclBRcmtNUGJGWkxjMWNudz09IiwibWFjIjoiMGQ2MjJiN2Q4OWFjM2Q5MWMxNTgzZWZlNmEwNDk5OWRlZWQzOWZjNjAyOGVkNzFkOTRlY2IxNjRiYWYzNTE1NSJ9; path=/; HttpOnly"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Tue, 12 Feb 2019 18:06:47 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"3374"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 3,\r\n \"name\": \"La Pedregoza\",\r\n \"description\": \"This afforestation and reforestation project is located in the Orinoco River basin of Colombia. The plantation is designed to provide long-term economic sustainability for the adjacent natural reserve, dedicated to the conservation of local flora & fauna. We use natural farming techniques to do so.\",\r\n \"slug\": \"la-pedregoza\",\r\n \"location\": \"Colombia\",\r\n \"lat\": 6.08824,\r\n \"long\": -67.723885,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/la-pedregoza\",\r\n \"species_price_from\": 2\r\n },\r\n {\r\n \"id\": 4,\r\n \"name\": \"Sacred Seeds\",\r\n \"description\": \"This project, situated on a 16 hectare parcel of land inside a natural reserve, involves the planting of a botanical garden in the Orinoco River basin to conserve its traditional medicinal trees and plants. The project is being done together with the Missouri Botanical Gardens in the USA.\",\r\n \"slug\": \"sacred-seeds\",\r\n \"location\": \"Colombia\",\r\n \"lat\": 6.08,\r\n \"long\": -67.703705,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/sacred-seeds\",\r\n \"species_price_from\": 2\r\n },\r\n {\r\n \"id\": 5,\r\n \"name\": \"Alamanga\",\r\n \"description\": \"Alamanga lutte contre la déforestation et préserve l'environnement grâce à une économie sociale et solidaire. Il s'attaque directement aux causes de la déforestation en gèrant durablement ses forêts et crée des revenus pour pérénniser l'implication des populations locales.\",\r\n \"slug\": \"alamanga\",\r\n \"location\": \"Madagascar\",\r\n \"lat\": -21.887999,\r\n \"long\": 46.929661,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/alamanga\",\r\n \"species_price_from\": 1\r\n },\r\n {\r\n \"id\": 6,\r\n \"name\": \"Bore\",\r\n \"description\": \"Sooner or later, our world is going to overheat if we do not protect and conserve the planet's tropical forests. Since 2007, this unique project has been working closely with ordinary Kenyan subsistence farmers to find ways to help them grow new food crops that reduce the stress on their forest.\",\r\n \"slug\": \"bore\",\r\n \"location\": \"Kenya\",\r\n \"lat\": -3.0939,\r\n \"long\": 39.918999,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/bore\",\r\n \"species_price_from\": 1\r\n },\r\n {\r\n \"id\": 7,\r\n \"name\": \"CommuniTree\",\r\n \"description\": \"A community-based reforestation initiative that regroups small-scale farming families to develop ecosystem services for the voluntary carbon market. Participants reforest and maintain under-utilized portions of their land in exchange for payments for ecosystem services.\",\r\n \"slug\": \"limay\",\r\n \"location\": \"Nicaragua\",\r\n \"lat\": 13.15,\r\n \"long\": -86.347,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/limay\",\r\n \"species_price_from\": 2\r\n },\r\n {\r\n \"id\": 8,\r\n \"name\": \"Les Hauts de France \",\r\n \"description\": \"9% ? C’est le taux de boisement de la région des « Hauts-de-France ». Ce qui fait de nous aujourd’hui, la région la moins boisée du pays. \\r\\nPour remédier à cela : une seule solution : la plantation ! \\r\\nC’est dans ce cadre que l’association Canopée reforestation a vu le jour il y a 6 ans.\\r\\n Depuis sa création, ce n’est pas moins de 41 238 arbres et arbustes qui ont été plantés sur l’ensemble de la région avec la participation des habitants.\",\r\n \"slug\": \"les-hauts-de-france\",\r\n \"location\": \"France\",\r\n \"lat\": 50.369701,\r\n \"long\": 2.655,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/les-hauts-de-france\",\r\n \"species_price_from\": 5\r\n },\r\n {\r\n \"id\": 9,\r\n \"name\": \"Tierras Morenas\",\r\n \"description\": \"We reforest degraded cattle pastures owned by Costa Ricans with diverse native trees, professionally managed for 25 years. We pay all tree planters a fair wage for their work over 4 years tending the trees so that they grow big and are able to survive long term. Fairly paid workers stops deforestation. Benefits include maximum capture of carbon dioxide, preservation of species of tropical plants and animals, and conservation of water supplies.\",\r\n \"slug\": \"tierras-morenas\",\r\n \"location\": \"Costa Rica\",\r\n \"lat\": 9.341,\r\n \"long\": -83.806999,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/tierras-morenas\",\r\n \"species_price_from\": 9\r\n },\r\n {\r\n \"id\": 10,\r\n \"name\": \"Oso Pardo\",\r\n \"description\": \"Para recuperar los bosques autóctonos y poner el valor el patrimonio local se quiere regenerar la conectividad de la biodiversidad, las culturas del norte peninsular y la calidad del suelo, reforestando espacios naturales protegidos azotados por incendios forestales hace unos años.\",\r\n \"slug\": \"oso-pardo\",\r\n \"location\": \"Spain\",\r\n \"lat\": 42.59,\r\n \"long\": -6.631,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/oso-pardo\",\r\n \"species_price_from\": 5\r\n },\r\n {\r\n \"id\": 11,\r\n \"name\": \"Dassa\",\r\n \"description\": \"Le projet « Planter pour la Planète » a été lancé par Madame Wangari Maathaï. Au Burkina, nous plantons dans la province du Sanguié en suivant les conseils de l’agroforesterie afin de faire reculer le désert.\",\r\n \"slug\": \"dassa\",\r\n \"location\": \"Burkina Faso\",\r\n \"lat\": 12.442,\r\n \"long\": -2.684,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/dassa\",\r\n \"species_price_from\": 2\r\n },\r\n {\r\n \"id\": 21,\r\n \"name\": \"Camino Verde\",\r\n \"description\": \"Deep in the heart of the Peruvian Amazon, Camino Verde is a US-based non-profit organization dedicated to: •Protecting and understanding biodiversity in the Peruvian Amazon. •Protecting indigenous rights, autonomy, and wisdom. •Spreading sustainable ways of life and encouraging fair, sustainable development. \\r\\nOur work lies at the intersection of people and forests. Our mission is to plant trees and encourage others to do the same.\",\r\n \"slug\": \"camino-verde\",\r\n \"location\": \"Peru\",\r\n \"lat\": -12.8294,\r\n \"long\": -69.447998,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/camino-verde\",\r\n \"species_price_from\": 1\r\n },\r\n {\r\n \"id\": 41,\r\n \"name\": \"Usambara Biodiversity Conservation\",\r\n \"description\": \"FOU will work with 3 primary and secondary schools in the Usambara Mountains to create a tree nursery project of 500,000 seedlings. Main activities include sensitization sessions to raise environmental awareness at the schools, creating tree nurseries, and distributing tree seedlings. Environmental clubs at the schools and their adult leaders, will work hard to make the nurseries a success. Every student will work on the project every Friday.\",\r\n \"slug\": \"usambara-biodiversity-conservation\",\r\n \"location\": \"Tanzania\",\r\n \"lat\": -4.75,\r\n \"long\": 38.5,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/usambara-biodiversity-conservation\",\r\n \"species_price_from\": 0.5\r\n },\r\n {\r\n \"id\": 60,\r\n \"name\": \"ARBA Sistema Litoral\",\r\n \"description\": \"ARBA Sistema Litoral es una asociación sin ánimo de lucro para la recuperación del bosque autóctono.\\r\\nActuamos en las cordilleras litorales catalanas.\\r\\nNuestro método se basa en las fases de sucesión forestal que se dan en cada ecosistema de forma natural: realizamos siembras y hemos inventado un nuevo sistema de plantación: el laberinto\\r\\n\",\r\n \"slug\": \"arba-sistema-litoral\",\r\n \"location\": \"España\",\r\n \"lat\": 41.259998,\r\n \"long\": 1.65,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/arba-sistema-litoral\",\r\n \"species_price_from\": 4\r\n },\r\n {\r\n \"id\": 121,\r\n \"name\": \"Saint Jean d'Illac\",\r\n \"description\": \"En juillet 2015, 580 hectares de forêt ont été décimés non loin du bassin d’Arcachon, de part et d’autre de la D 1250. L’incendie a commencé à Cestas le 17 juillet et a brûlé 7 hectares de Pins d’une vingtaine d’années, et s’est poursuivi le 24 Juillet près des voix SNCF à Saint Jean d’Illac. La mission de notre plantation est de reboiser les parties brûlées en juillet 2015.\\r\\n\\r\\n\",\r\n \"slug\": \"saint-jean-dillac-france\",\r\n \"location\": \"France\",\r\n \"lat\": 44.784218,\r\n \"long\": -0.765693,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/saint-jean-dillac-france\",\r\n \"species_price_from\": 3\r\n },\r\n {\r\n \"id\": 132,\r\n \"name\": \"Tumacoco\",\r\n \"description\": \"Somos alrededor de 7 a 15 Familias pertenecientes a la Costa Pacífica Colombiana (San Juan de la Costa en Tumaco - Nariño), nos dedicamos al cultivo del coco y la producción de aceite de coco 100% natural y artesanal, realizando un rescate de receta ancestral. Plantamos cocos a través de prácticas agro-ecológicas\\ny de agro-forestería que promuevan e incentivan la sostenibilidad del territorio.\",\r\n \"slug\": \"tumacoco\",\r\n \"location\": \"Colombia\",\r\n \"lat\": 2.339138,\r\n \"long\": -78.610214,\r\n \"status\": \"active\",\r\n \"url\": \"https://tree-nation.com/projects/tumacoco\",\r\n \"species_price_from\": 5\r\n }\r\n]"}],"_postman_id":"cd1c24a2-b231-4446-9bec-7d0cf7f6e31c"},{"name":"Project Sites list","id":"e3538e50-5cd9-4fe9-85f2-8dba0b4a18b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/projects/3/planting-sites","description":"

Retrieve the available planting sites in a project.

\n","urlObject":{"path":["api","projects","3","planting-sites"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"08d7c13b-ee1e-49e9-88ae-7a515bde7e34","name":"Sites list","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/projects/3/planting-sites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 May 2021 10:49:33 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6Im9lSE9tNFFVODNsK2gxSVJIR2JPTWc9PSIsInZhbHVlIjoicmxUM245Q081a2VQK2FmVEVlMWVZcjJiVWtQSjdZbUNtcVwvOWsrZTFcL2MwUEx0VkxYR21BRGNaWlQ3ZW8xR0RXUVBrd0pmVThwbjRFQ3pUOFRqTHZVdz09IiwibWFjIjoiZjg1NmI3MWI2ODM5YmE4YTE2ZTUzY2IxYzY1YWIwMDYxNjEwOTFiNDAzYjVkMGNiNzQ0YjI2MGEwOGNjNTUzYyJ9; expires=Tue, 04-May-2021 12:49:33 GMT; Max-Age=7200; path=/; secure"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImI1a2NrVkFOY3RXeVwvSWpNZGtGbW93PT0iLCJ2YWx1ZSI6IitVWER4SFFtTnVlXC81MWV1ZEpJdlVoejliRlp5bEIwbkNmQ2lLK3dnOGF0VE9qQXB5aCtSSitPWnA4TEY0RXlqTjFrQ0RuTnd1RCtRUElDeTNRazE3Zz09IiwibWFjIjoiMDc1Yzk0ZTNlOTVmZDFkNzg1NDdmZjkzNGFlYjFiNzUwYjY2MTBjMmMzZDU0ODU1ZmM0Mjk3YmYwOWJiYmU0YiJ9; path=/; secure; HttpOnly"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Tue, 04 May 2021 10:49:33 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"698"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"address\": \" \",\n \"created_at\": \"2016-04-22T11:52:52.000000Z\",\n \"description\": \"Amazonia Reforestation is a 3,000 hectare (7,410 acre) tropical tree plantation located in the Orinoco River basin of Colombia. The Orinoco River basin, together with the Amazon River basin, forms what is commonly referred to as the green lungs of our pla\",\n \"id\": 28,\n \"image\": \"site-571a10944216f.jpg\",\n \"name\": \"Amazonia Reforestation\",\n \"polygon_data\": \"[[6.096774473671085,-67.72642135620117],[6.097201199619592,-67.72358894348145],[6.089434734243303,-67.71929740905762],[6.091056313218727,-67.71080017089844],[6.075736463974203,-67.70749568939209],[6.073645420068276,-67.7193832397461],[6.073304024373687,-67.72238731384277]]\",\n \"project_id\": 3,\n \"slug\": \"amazonia-reforestation\"\n },\n {\n \"address\": \" \",\n \"created_at\": \"2016-04-22T11:54:51.000000Z\",\n \"description\": \"The Reserva Natural La Pedregoza is a protected area set aside for the conservation and preservation of flora and fauna in the Orinoco River basin of Vichada, Colombia. This natural reserve was founded by a Canadian family in 2009.\",\n \"id\": 29,\n \"image\": \"site-571a110b9cfe3.jpg\",\n \"name\": \"Reserva Natural La Pedregoza\",\n \"polygon_data\": \"[[6.096689128440647,-67.72659301757812],[6.09745723502575,-67.72247314453125],[6.0815828089245425,-67.71775245666504],[6.073474722248041,-67.71912574768066],[6.073304024373687,-67.72212982177734]]\",\n \"project_id\": 3,\n \"slug\": \"reserva-natural-la-pedregoza\"\n }\n]"}],"_postman_id":"e3538e50-5cd9-4fe9-85f2-8dba0b4a18b6"},{"name":"Project details","id":"2acd66b4-953a-4cb0-adf2-f4e8165e8b8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/projects/3","description":"

Retrieve the details about a project.

\n","urlObject":{"path":["api","projects","3"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b8777281-c731-499f-aafa-6693d09010ba","name":"Project details","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/projects/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Feb 2019 18:07:27 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjI5MWZWQklJTGZzU0RvRFg0WHlrS0E9PSIsInZhbHVlIjoiM3FGMlNwd0pkcEJQUVpLYThvV1VTS0xoUnVkTnZiVTZId21KbXFYMDFNOXRQXC9hcGJVYVVnUWtZRkdNSnRJM21FUlwvSXByMlNLTml6XC9PQU1MY2V4clE9PSIsIm1hYyI6IjM0NDhlYWQ4YmJkNWE1NDZhYzNhNjRkYTM4Y2RhZjMzZWE3M2FkZDcxMWZmOGM1Y2U3Y2U4M2FjZmZkMzI5MDkifQ%3D%3D; expires=Tue, 12-Feb-2019 20:07:27 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImZFSE0rUGNiWVAwcUpaNnBQaEJCT2c9PSIsInZhbHVlIjoiNExwdklJTE5TTUNHMTdzeUpIVTc4UyswY2RLVWtmYUZVc3lKR09cL0pRMHlUNzJNUE53QXNaMEUxSGJRMDFZdWdRSVVnaVl4Tm50R29RYlFBOTltTGdRPT0iLCJtYWMiOiIyNWE2MDE4OWExZTk0ZTM1MGEyZDg0YjM5YTFhMWQxNmMxZDk5ZDM4OWU5OGNlZDYwMGU1NDI4YzdhNGJkNjg5In0%3D; path=/; HttpOnly"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Tue, 12 Feb 2019 18:07:27 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"363"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"This afforestation and reforestation project is located in the Orinoco River basin of Colombia. The plantation is designed to provide long-term economic sustainability for the adjacent natural reserve, dedicated to the conservation of local flora & fauna. We use natural farming techniques to do so.\",\n \"id\": 3,\n \"image\": \"https://treenation-uploads-pre.s3.eu-central-1.amazonaws.com/project-570543715a901.jpg\",\n \"lat\": 6.08824,\n \"location\": \"CO\",\n \"long\": -67.723885,\n \"name\": \"La Pedregoza\",\n \"planting_density\": 1000,\n \"slug\": \"la-pedregoza\",\n \"species_price_from\": 1,\n \"status\": \"active\",\n \"url\": \"https://youcannevertestenough.tree-nation.com/projects/la-pedregoza\"\n}"}],"_postman_id":"2acd66b4-953a-4cb0-adf2-f4e8165e8b8a"}],"id":"2434181e-416e-4e95-bc77-256437506c97","description":"

Obtain all sorts of information about our projects.

Project list

Obtain the list of all active projects with the following details:

Description: The description of the project.
\n
id: The id of the project. You will need it when you want to obtain the list of species of that project.
\n
lat: Latitude.
\n
location: Country.
\n
long: Longitude.
\n
name: Name.
\n
slug: Last part of the project's URL.
\n
species_price_from: Minimum available species price.
\n
status: Active or inactive.
\n
url: The URL of the project.
\n

Project Sites list

A project may have one or multiple planting sites.

Obtain the list of the plantingf sites within a specific project:

address: Familiar local location of the project site.
\n
created_at: Date and time of the project site creation in our platform.
\n
description: Detailed description.
\n
id: Project site id.
\n
image: URL of the image.
\n
name: Name of the planting site.
\n
polygon_data: Exact latitude and longitude of the planting site's borders.
\n
project_id: id of the project
\n
slug: Last part of the project site's URL
\n

Project details

description: Detailed description.
\n
id: Project id.
\n
image: URL of the image.
\n
lat: Latitude.
\n
location: Country.
\n
long: Longitude.
\n
name: Name.
\n
planting_density: Number of trees planted per hectare.
\n
slug: Last part of the project's URL.
\n
species_price_from: Minimum available species price.
\n
status: Active or inactive.
\n
url: The URL of the project.
\n

\n","_postman_id":"2434181e-416e-4e95-bc77-256437506c97"},{"name":"Species information","item":[{"name":"Species list","id":"ef34a054-5da9-4742-8f1c-97159199a581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/projects/3/species","description":"

Retrieve the available species in a project. Only those species with stock > 0 can be used for planting.

\n","urlObject":{"path":["api","projects","3","species"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a0c21124-3f93-4a45-8a9b-7d66b2786362","name":"Species list","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/projects/3/species"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Feb 2019 18:07:53 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6Ik8xMTFWT3A1aWlieG00YjF0dE1YRFE9PSIsInZhbHVlIjoiTDE2YlQ4YnVmUThzYjJoN1o0VnloZmxPK1NtNEVXUUZrQmVWc1dzTEFpc1Zla3dwNkJsMCtjaVRJMEFiVUhjWTJuUzhVMWNtNFJpYk9BakoxdDhuNXc9PSIsIm1hYyI6IjhkMmI4YjIxYmQxNjMzM2NjNmExYjk3MjkzZjcwYmQ2YmY5ODFiMDUzOTgzOGE3NzRlMTJjY2MzNjlhYTY2NjMifQ%3D%3D; expires=Tue, 12-Feb-2019 20:07:53 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlNCdGxMTWw4WDlrbm5oWVhOYlJYbXc9PSIsInZhbHVlIjoiZ1dWakF3THdINlNUZUtiMjJGM2c5UUF4eEhFWFBwaEZlR29DSHJBYnlFV0QzdUVjbFZvTk01aFI1TFFWekh0ZUQ4eXJmV0VrOENZUjFEeGVDYTdJRWc9PSIsIm1hYyI6IjI4ODM5NWViNzRkM2MzYTAyNWVhNmNlNWJhYzQ5YTc3ODQzOGZiNDE5OGJiN2ZlNDgyNjQ1NWFlY2YxNDFlNTAifQ%3D%3D; path=/; HttpOnly"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Tue, 12 Feb 2019 18:07:53 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"962"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 42,\n \"project_id\": 3,\n \"name\": \"Acacia mangium\",\n \"life_time_CO2\": 220,\n \"price\": 3,\n \"stock\": 0\n },\n {\n \"id\": 43,\n \"project_id\": 3,\n \"name\": \"Eucalyptus pellita\",\n \"life_time_CO2\": 220,\n \"price\": 4,\n \"stock\": 0\n },\n {\n \"id\": 44,\n \"project_id\": 3,\n \"name\": \"Pinus caribaea\",\n \"life_time_CO2\": 600,\n \"price\": 3,\n \"stock\": 0\n },\n {\n \"id\": 45,\n \"project_id\": 3,\n \"name\": \"Gmelina arborea\",\n \"life_time_CO2\": 220,\n \"price\": 3,\n \"stock\": 0\n },\n {\n \"id\": 46,\n \"project_id\": 3,\n \"name\": \"Azadirachta indica\",\n \"life_time_CO2\": 680,\n \"price\": 3,\n \"stock\": 0\n },\n {\n \"id\": 47,\n \"project_id\": 3,\n \"name\": \"Hymenaea courbaril\",\n \"life_time_CO2\": 720,\n \"price\": 6,\n \"stock\": 2047\n },\n {\n \"id\": 48,\n \"project_id\": 3,\n \"name\": \"Anacardium occidentale\",\n \"life_time_CO2\": 550,\n \"price\": 10,\n \"stock\": 22692\n },\n {\n \"id\": 49,\n \"project_id\": 3,\n \"name\": \"Jatropha curcas\",\n \"life_time_CO2\": 100,\n \"price\": 3,\n \"stock\": 10945\n },\n {\n \"id\": 50,\n \"project_id\": 3,\n \"name\": \"Caraipa llanorum\",\n \"life_time_CO2\": 440,\n \"price\": 4,\n \"stock\": 0\n },\n {\n \"id\": 51,\n \"project_id\": 3,\n \"name\": \"Acosmium nitens\",\n \"life_time_CO2\": 360,\n \"price\": 4,\n \"stock\": 109340\n },\n {\n \"id\": 52,\n \"project_id\": 3,\n \"name\": \"Vochysia obscura\",\n \"life_time_CO2\": 440,\n \"price\": 5,\n \"stock\": 26282\n },\n {\n \"id\": 53,\n \"project_id\": 3,\n \"name\": \"Ocotea cymbarum\",\n \"life_time_CO2\": 440,\n \"price\": 4,\n \"stock\": 0\n },\n {\n \"id\": 54,\n \"project_id\": 3,\n \"name\": \"Albizia saman\",\n \"life_time_CO2\": 440,\n \"price\": 4,\n \"stock\": 3085\n },\n {\n \"id\": 55,\n \"project_id\": 3,\n \"name\": \"Swietenia macrophylla\",\n \"life_time_CO2\": 600,\n \"price\": 6,\n \"stock\": 262\n },\n {\n \"id\": 56,\n \"project_id\": 3,\n \"name\": \"Hura crepitans\",\n \"life_time_CO2\": 440,\n \"price\": 14,\n \"stock\": 194\n },\n {\n \"id\": 57,\n \"project_id\": 3,\n \"name\": \"Pachira quinata\",\n \"life_time_CO2\": 440,\n \"price\": 8,\n \"stock\": 0\n },\n {\n \"id\": 58,\n \"project_id\": 3,\n \"name\": \"Maclura tinctoria\",\n \"life_time_CO2\": 560,\n \"price\": 8,\n \"stock\": 3175\n },\n {\n \"id\": 59,\n \"project_id\": 3,\n \"name\": \"Handroanthus chrysanthus\",\n \"life_time_CO2\": 440,\n \"price\": 4,\n \"stock\": 0\n },\n {\n \"id\": 104,\n \"project_id\": 3,\n \"name\": \"Enterolobium cyclocarpum\",\n \"life_time_CO2\": 480,\n \"price\": 6,\n \"stock\": 2376\n },\n {\n \"id\": 105,\n \"project_id\": 3,\n \"name\": \"Pseudosamanea guachapele\",\n \"life_time_CO2\": 560,\n \"price\": 6,\n \"stock\": 1190\n },\n {\n \"id\": 106,\n \"project_id\": 3,\n \"name\": \"Citrus limon\",\n \"life_time_CO2\": 255,\n \"price\": 9,\n \"stock\": 826\n },\n {\n \"id\": 107,\n \"project_id\": 3,\n \"name\": \"Citrus reticulata\",\n \"life_time_CO2\": 120,\n \"price\": 8,\n \"stock\": 525\n },\n {\n \"id\": 108,\n \"project_id\": 3,\n \"name\": \"Citrus sinensis\",\n \"life_time_CO2\": 260,\n \"price\": 8,\n \"stock\": 521\n },\n {\n \"id\": 109,\n \"project_id\": 3,\n \"name\": \"Gliricidia sepium\",\n \"life_time_CO2\": 100,\n \"price\": 8,\n \"stock\": 176\n },\n {\n \"id\": 110,\n \"project_id\": 3,\n \"name\": \"Mangifera indica\",\n \"life_time_CO2\": 360,\n \"price\": 10,\n \"stock\": 4140\n },\n {\n \"id\": 111,\n \"project_id\": 3,\n \"name\": \"Tamarindus indica\",\n \"life_time_CO2\": 450,\n \"price\": 14,\n \"stock\": 392\n },\n {\n \"id\": 112,\n \"project_id\": 3,\n \"name\": \"Licania pyrifolia\",\n \"life_time_CO2\": 280,\n \"price\": 14,\n \"stock\": 1100\n },\n {\n \"id\": 113,\n \"project_id\": 3,\n \"name\": \"Psidium guajava\",\n \"life_time_CO2\": 240,\n \"price\": 4,\n \"stock\": 887\n },\n {\n \"id\": 114,\n \"project_id\": 3,\n \"name\": \"Calophyllum lucidum\",\n \"life_time_CO2\": 450,\n \"price\": 14,\n \"stock\": 1443\n },\n {\n \"id\": 115,\n \"project_id\": 3,\n \"name\": \"Minquartia guianensis\",\n \"life_time_CO2\": 360,\n \"price\": 14,\n \"stock\": 722\n },\n {\n \"id\": 116,\n \"project_id\": 3,\n \"name\": \"Sclerolobium hypoleucon\",\n \"life_time_CO2\": 320,\n \"price\": 8,\n \"stock\": 65\n },\n {\n \"id\": 117,\n \"project_id\": 3,\n \"name\": \"Pouteria caimito\",\n \"life_time_CO2\": 400,\n \"price\": 14,\n \"stock\": 0\n },\n {\n \"id\": 118,\n \"project_id\": 3,\n \"name\": \"Moringa oleifera\",\n \"life_time_CO2\": 120,\n \"price\": 8,\n \"stock\": 2858\n },\n {\n \"id\": 234,\n \"project_id\": 3,\n \"name\": \"Eucalyptus introgresión \",\n \"life_time_CO2\": 220,\n \"price\": 4,\n \"stock\": 66292\n },\n {\n \"id\": 236,\n \"project_id\": 3,\n \"name\": \"Carica papaya\",\n \"life_time_CO2\": 150,\n \"price\": 4,\n \"stock\": 344\n },\n {\n \"id\": 237,\n \"project_id\": 3,\n \"name\": \"Persea Americana\",\n \"life_time_CO2\": 150,\n \"price\": 6,\n \"stock\": 320\n },\n {\n \"id\": 239,\n \"project_id\": 3,\n \"name\": \"Anadenanthera peregrina\",\n \"life_time_CO2\": 100,\n \"price\": 4,\n \"stock\": 1598\n },\n {\n \"id\": 518,\n \"project_id\": 3,\n \"name\": \"Vochysia lehmannii\",\n \"life_time_CO2\": 380,\n \"price\": 2,\n \"stock\": 14087\n },\n {\n \"id\": 519,\n \"project_id\": 3,\n \"name\": \"Vitex orinocensis\",\n \"life_time_CO2\": 360,\n \"price\": 2,\n \"stock\": 10955\n },\n {\n \"id\": 520,\n \"project_id\": 3,\n \"name\": \"Guazuma ulmifolia\",\n \"life_time_CO2\": 300,\n \"price\": 4,\n \"stock\": 0\n }\n]"}],"_postman_id":"ef34a054-5da9-4742-8f1c-97159199a581"},{"name":"Species details","id":"b862d539-9aa5-483c-b4cc-4ebf7e4e609d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/species/727","description":"

Retrieve the details about a specie.

\n","urlObject":{"path":["api","species","727"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"31c83851-6380-46e6-a372-f2f9d37b50b8","name":"Species details","originalRequest":{"method":"GET","header":[],"url":"https://tree-nation.com/api/species/48"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 Feb 2019 18:14:04 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjB2VVZmeG1pR3M1bWpmZUU4MEthMlE9PSIsInZhbHVlIjoiMk5MQVBmWVpQOHpsOXRzbmVuZE1yS2ZJOTRzWWk2UmRMMGFIVTVDQkhLQVN5dktLaUhxVVwvUVhpNUZ4cFkweTZFS3pDTThqTWM3WHI4bTNvbTFYYzVRPT0iLCJtYWMiOiI2NmYwMjRjODJmNDI5ZmI2YzRiZGU1Mjg2ZDQwMzc5MWU5NDFmNmVkZjhjZWM1NzNkNzQzNzRlMTY2NTgyNjI0In0%3D; expires=Tue, 12-Feb-2019 20:14:04 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkxSdWFENXFMc3dhK3ZtT3RLZ0tEOGc9PSIsInZhbHVlIjoieGVyRE1WRHpEdXdRaFNNVTVpM0lZUm5nc0lUZTVuZzN6OFp6amhqdUZJY3RmbGJUT3JmblRscXlZNVhBNzQ1bXpRbFlSQ2tud1dsck5WdzBkQ2hBa0E9PSIsIm1hYyI6IjY3ZjBmMjMxYmI3NzgxZTVmZDVmODA2MGU3YzIwNjQ1MDEzZjg1MDNlNDIyOTA5ODk4YzI1NmNhOGQ1YTk0NWIifQ%3D%3D; path=/; HttpOnly"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Tue, 12 Feb 2019 18:14:04 GMT"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Length","value":"901"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 48,\n \"project_id\": 3,\n \"name\": \"Anacardium occidentale\",\n \"life_time_CO2\": 550,\n \"price\": 10,\n \"common_names\": \"Cashew Nut, Cashew Tree, Acajou, Anacadier, Anacarde, Noix d' Cajou, Pomme Acajou, Pommier Cajou, Marañon, Acaya, Cacajuil, Cajuil, Casho, Cashú, Kasjoe, Mereke, Cashenuß, Acajubaum, Elefantenlaus, Kaschubaum\",\n \"image\": \"https://treenation-uploads.s3-accelerate.amazonaws.com/specie-576431f6c7ddd.jpg\",\n \"family\": \"Anacardiaceae\",\n \"particularities\": \"Anacardium occidentale is cultivated for its nuts. Botanically, the nut is the fruit; the cashew apple is the swollen, fleshy fruit stalk. The seeds kernels are extracted by shelling the roasted nuts. In production areas, cashew serves as food. Elsewhere it forms a delicacy. The kernels are nutritious, containing fats, proteins, carbohydrates, vitamins and minerals.\\r\\n There are numerous medicinal applications for its oil and fruits. The fruits are used to make wines and liquors. The trees produce fruits for about 30 years. Cashew yields gums and resins used in varnish, paints, adhesives, brake linings and more.\\r\\nBecause of its extreme tolerance of external conditions, it can be used for land reclamation and erosion control.\\r\\n\",\n \"planter_likes\": \"Anacardium occidentale is native to the Orinoco River basin. The wood is used in specialty applications and for fuel and charcoal.\\r\\n\\r\\nThe trees produce fruits for about 25 years.\",\n \"height\": \"12,15\",\n \"average_natural_life_span\": 70,\n \"co2_offset\": 22,\n \"co2_offset_period\": \"0,25\",\n \"stock\": 22692,\n \"category\": {\n \"id\": 2,\n \"name\": \"Nutritional\"\n },\n \"foliage\": {\n \"id\": 4,\n \"name\": \"Evergreen\"\n },\n \"origin_type\": {\n \"id\": 1,\n \"name\": \"Native\"\n }\n}"}],"_postman_id":"b862d539-9aa5-483c-b4cc-4ebf7e4e609d"}],"id":"1a28ad5f-760d-4efd-b00a-6ade19d7cdaa","description":"

Obtain all sorts of information about our species

Species list

Obtain the list of all species within a project and their information respectively.

id: id of the species.
life_time_CO2: Total amount of CO2 compensated by the species.
name: Name of the species.
price: Price of the species.
project_id: id of the project.
stock: Number of trees available to plant.

Species details

average_natural_life_span: Lifespan in years
\n
category:
\n
- id: id of the category
- name: Category name (i.e: nutitional)
\n
co2_offset: 22,
\n
co2_offset_period: \"0,20\",
\n
common_names: Other species names.
\n
foliage:
\n
- deprecated: This field will be removed in future versions, please use the field 'foliage_type
  \n
- id: id of the foliage type.
  \n
- name: Foliage name.
  \n
\n
foliage_type: {
\n
- id: id of the foliage type.
  \n
- name: Foliage type name.
  \n
\n
height: Tree height in meters.
\n
id: species_id.
\n
image: Species image URL
\n
life_time_CO2: Total CO2 compensated.
\n
name: Species name.
\n
origin_type:
\n
- id: ID of the species type.
  \n
- name: type of the species.
  \n
\n
particularities: More details about the species.
\n
planter_likes: Liked details from the planter.
\n
price: Price of the species.
\n
project_id: id of the project the species belong to.
\n
stock: total number of trees available for planting in the project's stock.
\n

\n","_postman_id":"1a28ad5f-760d-4efd-b00a-6ade19d7cdaa"}],"id":"5e588d25-af81-4a05-9128-5cc90cba9d33","description":"

These methods are accessible without Authorization

Forest counter

Obtain information from your forest such as the number of trees planted and the amount of CO2 compensated.

Project information

Obtain all sorts of information about our projects.

Species information

Obtain all sorts of information about our species.

Updates

Obtain project updates.

\n","_postman_id":"5e588d25-af81-4a05-9128-5cc90cba9d33"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ab269b25-ee97-4dbb-a248-b784f1df7d07"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"acb80e18-217b-4183-8c10-b55629daedea"}}],"variable":[{"key":"project_id","value":"3"},{"key":"species_id","value":"727"},{"key":"user_id","value":"32"},{"key":"user_slug","value":"maxime-renaudin"},{"key":"period","value":"month"}]}