Developers
API referenceGift codes

List gift codes

GET
/gift-codes

Gift codes of your company, newest first.

Filters: status, external_reference, updated_since, created_since.

Scope: gift-codes: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

  • "open"
  • "claimed"
  • "expired"
  • "revoked"
external_reference?string
Lengthlength <= 255
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.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/gift-codes"
{  "object": "list",  "url": "/v2/gift-codes",  "has_more": false,  "data": [    {      "id": "gift_8bW1vT9yN6pDmQ2xL7rCkZa3",      "object": "gift_code",      "livemode": true,      "code": "WYC-7K3M-PLANT",      "claim_url": "https://woodyou.care/gift/example/WYC-7K3M-PLANT",      "status": "open",      "trees": 1,      "project": null,      "sent_to": {        "name": "John Doe",        "email": "john@example.com"      },      "external_reference": "XMAS-2026-0042",      "recipient": null,      "valid_until": "2027-01-31T23:59:59Z",      "claimed_at": null,      "created_at": "2026-12-01T09:00:00Z",      "updated_at": "2026-12-01T09:00:00Z"    }  ]}

Email the certificate again POST

Sends the certificate email to the recipient again, for example after correcting the email address. Test tokens never send email; the request still succeeds. Scope: `recipients:write`.

Create a gift code POST

Reserves `trees` trees from your unassigned trees behind a code. When a person claims the code at `/gift`, they become a recipient with a personal certificate and the `recipient.claimed` webhook fires. The Platform does not email the code; you hand it out yourself, for example in an order confirmation. Requires an `Idempotency-Key`. Scope: `gift-codes:write`.