Get Certificate

GET /certificates/{certificate}

Certificates are the proof of planting, and are used to show the impact of the tree planting.

Path parameters

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object

    Orders are placed to fund the planting of trees. Once orders are fulfilled they should be imported. Feel free to import allocatedUnits from unfulfilled orders if you wish, but make sure you deduplicate by tree id.

  • 404 application/problem+json

    Certificate not found.

    Hide response attributes Show response attributes object

    IETF RFC 8707 compliant problem details.

GET /certificates/{certificate}
curl \
 -X GET https://api.protect.earth/certificates/53f7bd7b-2ee2-4be4-a15b-e09c76a150f9
Response examples (200)
{
  "id": "string",
  "brand": "string",
  "recipientName": "string",
  "personalisedMessage": "string",
  "unitType": "tree",
  "numberOfUnits": 12,
  "unit": {
    "id": "o2j",
    "unitType": "tree",
    "location": {
      "latitude": 51.87351,
      "longitude": -1.90973,
      "name": "Hawling, England",
      "what3words": "headlight.hunches.heads"
    },
    "photos": [],
    "species": "Silver Birch",
    "plantedOn": "2021-12-26T15:20:42.000000Z"
  },
  "organisation": {
    "name": "Acme Corp",
    "logo": "string"
  },
  "event": {
    "name": "Tree planting event",
    "logo": "string"
  }
}
Response examples (404)
{
  "type": "https://protect.earth/probs/something-went-wrong",
  "title": "You do not have enough credit.",
  "status": 400,
  "detail": "Your current balance is 30, but that costs 50.",
  "instance": "/account/12345/msgs/abc"
}