Tree Tracker API

Get Certificate

GET /certificates/{certificate}

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

Path parameters

certificate string(uuid) Required

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- id string(uuid) Required
- brand string(slug)
  
  Format should match the following pattern: [a-z\-]+.
- recipientName string
- personalisedMessage string
- unitType string Required
  
  Values are tree, biodiversity, or hedgerow.
- numberOfUnits integer
  
  Minimum value is 1.
- unit object
  
  Hide unit attributes Show unit attributes
  
  id string Required
  
  unitType string Required
  
  Values are tree, biodiversity, or hedgerow.
  
  location object Required
  
  Hide location attributes Show location attributes
  
  latitude number(double) Required
  
  longitude number(double) Required
  
  name string Required
  
  what3words string Required
  
  photos array Required
  
  species string
  
  plantedOn string(date-time)
- organisation object
  
  Hide organisation attributes Show organisation attributes
  
  name string Required
  
  logo string(url) Required
- event object
  
  Hide event attributes Show event attributes
  
  name string Required
  
  logo string(url) Required
• 404 application/problem+json

Certificate not found.
Hide response attributes Show response attributes object
- type string Required
- title string Required
- status integer
- detail string
- instance string

GET /certificates/{certificate}

curl \
 -X GET https://hostname/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"
  }
}