Developers
API referenceAllocations

List allocations

GET
/allocations

Allocations of your company, newest first. One allocation is a number of trees from one planting.

Filters: status, project, planting, recipient, source, updated_since, created_since. Expand planting, project or recipient to include them. Live tokens see everything except test allocations; test tokens see the same plus their own test allocations.

Scope: allocations:read.

Authorization

bearerAuth
AuthorizationBearer <token>

A Platform API token, wyc_live_... or wyc_test_..., created at Settings > API tokens in the dashboard.

In: header

Query Parameters

status?string

Value in

  • "pledged"
  • "planted"
  • "monitored"
recipient?string

Only allocations assigned to this recipient (rcp_...), or none for unassigned ones.

source?string

Value in

  • "foundation"
  • "legacy"
project?string

Only objects of this project (prj_...).

planting?string

Only objects of this planting (plt_...).

updated_since?string

Only objects updated at or after this ISO 8601 time.

Formatdate-time
created_since?string

Only objects created at or after this ISO 8601 time.

Formatdate-time
limit?integer

Number of objects to return, 1 to 100.

Range1 <= value <= 100
Default25
starting_after?string

Cursor: the id of the last object of the previous page.

expand[]?array<>

Include related objects instead of their ids: planting, project, recipient.

Header Parameters

Accept-Language?string

Language of translated texts such as project names and species: en (default) or nl.

Value in

  • "en"
  • "nl"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/allocations"
{  "object": "list",  "url": "/v2/allocations",  "has_more": false,  "data": [    {      "id": "alloc_6yN3pDmQ2xL7rCkZa8bW1vT9",      "object": "allocation",      "livemode": true,      "trees": 250,      "status": "monitored",      "source": "foundation",      "planting": "plt_4vT9bW1kZa8yN3pDmQ2xL7rC",      "project": "prj_9Lp3xW7mQv2kT8bZa4yR6cN1",      "recipient": null,      "certificate": null,      "allocated_at": "2026-01-15T08:05:00Z",      "planted_at": "2026-01-12",      "legacy_tree_ids": [],      "legacy_order_id": null,      "created_at": "2026-01-15T08:05:00Z",      "updated_at": "2026-07-21T10:00:00Z"    }  ]}

Retrieve your company GET

Your company with its tree totals by status, the number of unassigned trees and counts of projects, plantings, recipients and certificates. The successor of `GET /v1/get-stats`. Scope: `company:read`.

Retrieve an allocation GET

One allocation. Expand `planting`, `project` or `recipient` to include them. Scope: `allocations:read`.