Developers
API referenceAllocations

Retrieve an allocation

GET
/allocations/{id}

One allocation. Expand planting, project or recipient to include them.

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

Path Parameters

id*string

Id of the allocation.

Match^alloc_[A-Za-z0-9]{24}$

Query Parameters

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

application/json

curl -X GET "https://example.com/allocations/string"
{  "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"}

List allocations GET

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`.

List plantings GET

Plantings with trees of your company, newest first, each with its proof dossier: species, polygon, photos, latest monitoring and verification. Filters: `project`, `source`, `updated_since`, `created_since`. `updated_since` also catches dossier additions such as new photos or a monitoring measurement. Scope: `plantings:read`.