Skip to main content
GoodAPI: Plant Trees logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: GOODAPI_PLANT_TREES
  • Version: 20261030_00

Tools

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

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOODAPI_PLANT_TREES_GET_AGGREGATE_PLANTING_EVIDENCEReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOODAPI_PLANT_TREES_GET_IMPACT_DASHBOARD_URLReturn the connected organization’s shareable public impact dashboard URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOODAPI_PLANT_TREES_GET_TREE_PLANTING_EVIDENCEReturn 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

string
required
Tree-planting registration ID whose lifecycle evidence to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOODAPI_PLANT_TREES_LIST_TREE_PLANTINGSReturn 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

string
Optional end date in YYYY-MM-DD format for the provider’s date filter.
string
Filter registrations by their attribution label.
string
Filter by creation date in YYYY-MM-DD format.
string
Optional JSON-encoded object used to match registration metadata; avoid personal or secret values.
string
Return the tree planting with this registration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOODAPI_PLANT_TREES_REFUND_TREE_PLANTINGIrreversibly 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not