GET /v1/certificates — Retrieve Tree Planting Certificates for Your Organization

Fetch a paginated list or a single certificate by ID.
Two response views are available — summary (lightweight) and detail (full data including project and gift info).

Base URL

https://api.bloomy.earth

Endpoint Variants

Authentication & Headers

Authentication uses HTTP Basic Auth with your Bloomy Earth API credentials. You must use your Bloomy Earth platform username and application password.

You can find and manage these credentials in your Bloomy Earth dashboard, in the Integration API section:
👉 https://www.bloomy.earth/dashboard/#bloomy-integration-api

Headers

Query Parameters

Example Requests

1️⃣ Paginated summary (default view):

curl -X GET "https://api.bloomy.earth/v1/certificates?page=1&perPage=10" \
  -u YOUR_BLOOMY_USERNAME:YOUR_APPLICATION_PASSWORD \
  -H "Accept: application/json"

2️⃣ Paginated detail view:

curl -X GET "https://api.bloomy.earth/v1/certificates?page=1&perPage=10&view=detail" \
  -u YOUR_BLOOMY_USERNAME:YOUR_APPLICATION_PASSWORD \
  -H "Accept: application/json"

3️⃣ Get one certificate by ID:

curl -X GET "https://api.bloomy.earth/v1/certificates/CERTIFICATE_ID" \
  -u YOUR_BLOOMY_USERNAME:YOUR_APPLICATION_PASSWORD \
  -H "Accept: application/json"

JSON Response (200)

1️⃣ Paginated Summary View (?view=summary, default)

{
  "page": 1,
  "perPage": 3,
  "total": 7,
  "totalPages": 3,
  "items": [
    {
      "certificateId": 72367198438,
      "certificateLink": "https://www.bloomy.earth/certificate/72367198438/",
      "projectName": "Lake Victoria Agroforestry Project in Kenya",
      "country": "Kenya",
      "quantity": 1,
      "carbonOffsetKg": 50,
      "createdAt": "2025-11-03T22:33:11+00:00"
    },
    {
      "certificateId": 71975058226,
      "certificateLink": "https://www.bloomy.earth/certificate/71975058226/",
      "projectName": "Landscape Restoration – Sunkoshi Basin in Nepal",
      "country": "Nepal",
      "quantity": 1,
      "carbonOffsetKg": 50,
      "createdAt": "2025-06-11T18:03:27+00:00"
    }
  ]
}

2️⃣ Paginated Detailed View (?view=detail)

{
  "page": 1,
  "perPage": 2,
  "total": 7,
  "totalPages": 4,
  "items": [
    {
      "certificateId": 853102,
      "certificateLink": "https://www.bloomy.earth/certificate/853102/",
      "projectInfo": {
        "name": "Lake Victoria Agroforestry Project in Kenya",
        "country": "Kenya",
        "location": "VQ27+Q7C Kisumu, Kenya",
        "quantity": 5,
        "carbonOffsetKg": 250,
        "reforestedAreaHa": 0.005
      },
      "isVcsCertified": true,
      "creditsUsed": 20,
      "giftSentTo": "john@example.com",
      "createdAt": "2025-11-05T15:22:00+00:00"
    },
    {
      "certificateId": 853103,
      "certificateLink": "https://www.bloomy.earth/certificate/853103/",
      "projectInfo": {
        "name": "Restoring the Monarch Butterfly Sanctuary in Mexico",
        "country": "Mexico",
        "location": "MX82+T4T Michoacán, Mexico",
        "quantity": 10,
        "carbonOffsetKg": 500,
        "reforestedAreaHa": 0.01
      },
      "isVcsCertified": false,
      "creditsUsed": 10,
      "createdAt": "2025-11-04T09:42:15+00:00"
    }
  ]
}

3️⃣ Single Certificate (/v1/certificates/{certificateId})

{
  "success": true,
  "certificateId": 853102,
  "certificateLink": "https://www.bloomy.earth/certificate/853102/",
  "projectInfo": {
    "name": "Lake Victoria Agroforestry Project in Kenya",
    "country": "Kenya",
    "location": "VQ27+Q7C Kisumu, Kenya",
    "quantity": 5,
    "carbonOffsetKg": 250,
    "reforestedAreaHa": 0.005
  },
  "isVcsCertified": true,
  "creditsUsed": 20,
  "giftSentTo": "john@example.com",
  "createdAt": "2025-11-05T15:22:00+00:00"
}

Response Fields

Errors

If the request is missing required data or contains invalid parameters, the API returns a JSON object with an error code and a short message.

Error format:

{
  "error": "forbidden",
  "message": "Authentication failed."
}