Get Site

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/protect-earth/doc/partner-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Partner API MCP server": {
    "url": "https://bump.sh/protect-earth/doc/partner-api/mcp"
  }
}

Close
GET /sites/{site_uuid}

Returns a single site and the associated work records.

Path parameters

  • site_uuid string(uuid) Required

    UUID of the site.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string(uuid) Required
    • name string Required
    • location string Required
    • description string | null Required
    • images array[string(uri)] Required
    • species array[object] Required

      Different types of units.

      Hide species attributes Show species attributes object

      Different types of units.

      • id string(uuid) Required
      • name string Required
    • work array[object] Required

      Array of work completed on this site, grouped by product type

      Hide work attributes Show work attributes object
      • name string Required

        Name of the product type

      • units integer(int64) Required

        Number of units for this product type

      • label string Required

        Display label for the product type

    • funding array[object] Required

      Counts of sponsored and unsponsored units for each product type on the site

      Hide funding attributes Show funding attributes object
      • name string Required

        Name of the product type

      • label string Required

        Display label for the product type

      • allocatedUnits integer(int64) Required

        Number of units already sponsored for this work type

      • unallocatedUnits integer(int64) Required

        Number of units still needing sponsorship for this work type

    • coordinates object | null Required
      Hide coordinates attributes Show coordinates attributes object | null
      • latitude number Required
      • longitude number Required
  • 404 application/problem+json

    Site not found.

    Hide response attributes Show response attributes object
    • type string Required
    • title string Required
    • status integer
    • detail string
    • instance string
GET /sites/{site_uuid}
curl \
 --request GET 'https://api.protect.earth/sites/{site_uuid}'
Response examples (200)
{
  "id": "string",
  "name": "Bourton on the Water",
  "location": "Cheltenham, England",
  "description": "A mixed habitat restoration site.",
  "images": [
    "https://example.com"
  ],
  "species": [
    {
      "id": "string",
      "name": "Wild Cherry"
    }
  ],
  "work": [
    {
      "name": "Ancient Woodland Restoration",
      "units": 350,
      "label": "square meters"
    }
  ],
  "funding": [
    {
      "name": "Ancient Woodland Restoration",
      "label": "trees",
      "allocatedUnits": 120,
      "unallocatedUnits": 30
    }
  ],
  "coordinates": {
    "latitude": 42.0,
    "longitude": 42.0
  },
  "links": {
    "self": "https://example.com",
    "all": "https://example.com",
    "map": "https://example.com"
  }
}
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"
}