---
canonical_url: "https://docs.composio.dev/toolkits/goodapi_plant_trees"
markdown_url: "https://docs.composio.dev/toolkits/goodapi_plant_trees.md"
product: "platform"
version: null
last_updated: null
---

# GoodAPI: Plant Trees

Plant and track trees through GoodAPI's standalone API, retrieve planting evidence, issue eligible tree refunds, and access the organization's impact dashboard.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `GOODAPI_PLANT_TREES`
- **Version:** 00000000_00

## Tools

### Create Tree Planting

**Slug:** `GOODAPI_PLANT_TREES_CREATE_TREE_PLANTING`

Create a metered tree-planting registration; live API keys can incur charges. Reuse the same idempotency key only when retrying the identical planting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | Yes | Number of trees to plant; must be at least 1. |
| `metadata` | object | No | Optional JSON metadata for non-sensitive correlation data; do not include personal, payment, or secret values. |
| `attribution` | string | No | Optional non-sensitive label for attributing this planting in later reports and filters. |
| `idempotency_key` | string | Yes | Stable unique key for this exact planting. Reuse it for an identical retry and never reuse it for a different planting. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aggregate Planting Evidence

**Slug:** `GOODAPI_PLANT_TREES_GET_AGGREGATE_PLANTING_EVIDENCE`

Return global tree-planting verification totals and field evidence grouped by region. The data is cached for 30 days, can contain a large media list, and is not limited to the connected organization's contributions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Impact Dashboard URL

**Slug:** `GOODAPI_PLANT_TREES_GET_IMPACT_DASHBOARD_URL`

Return the connected organization's shareable public impact dashboard URL.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tree Planting Evidence

**Slug:** `GOODAPI_PLANT_TREES_GET_TREE_PLANTING_EVIDENCE`

Return the beta, 30-day-cached planting lifecycle and sanitized evidence for one registration. This timeline can remain after refund and does not prove that the registration is still active.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `registration_id` | string | Yes | Tree-planting registration ID whose lifecycle evidence to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tree Plantings

**Slug:** `GOODAPI_PLANT_TREES_LIST_TREE_PLANTINGS`

Return tree-planting registrations and totals, optionally filtered by registration, attribution, date, or metadata. The provider returns all matches without pagination, so use filters for large histories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | Optional end date in YYYY-MM-DD format for the provider's date filter. |
| `attribution` | string | No | Filter registrations by their attribution label. |
| `created_date` | string | No | Filter by creation date in YYYY-MM-DD format. |
| `metadata_json` | string | No | Optional JSON-encoded object used to match registration metadata; avoid personal or secret values. |
| `registration_id` | string | No | Return the tree planting with this registration ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Refund Tree Planting

**Slug:** `GOODAPI_PLANT_TREES_REFUND_TREE_PLANTING`

Irreversibly refund all or part of an eligible tree planting from the current billing cycle and reduce active totals. Omit count for a full refund; reuse the same idempotency key only for an identical retry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of trees to refund for a partial refund; omit to refund the full eligible registration. |
| `reason` | string | No | Optional non-sensitive reason for the refund. |
| `metadata` | object | No | Optional JSON metadata for non-sensitive refund correlation; do not include personal, payment, or secret values. |
| `idempotency_key` | string | Yes | Stable unique key for this exact refund. Reuse it for an identical retry and never reuse it for a different refund. |
| `registration_id` | string | Yes | ID of the tree-planting registration to refund. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |