Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Project

Information about a specific project.

get/projects/{id}

Path parameters

idstring required
Example:prj_1CTWZQGKE1S0VAXA

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required
namestring required
status'draft' | 'preview' | 'under_validation' | 'validated' | 'validation_unsuccessful' | 'cancelled' required
short_codestring required

A random short code, uniquely identifying the project

urlstring required

The url to the Isometric page for this project

pathway'biomass_carbon_removal_and_storage' | 'biosphere' | 'direct_air_capture' | 'enhanced_weathering' | 'carbon_mineralization' | 'marine' | 'superpollutants' | 'environmental_attribute_certificates' required
durability'permanent' | 'over_one_thousand_years' | 'over_two_hundred_years' | 'over_one_hundred_years' | 'over_eighty_years' | 'over_sixty_years' | 'over_forty_years' required

Durability of carbon removal performed by the project, which is a function of the selected protocol and possibly some relevant project protocol settings.

protocol_slugstring required

A protocol's URL-friendly identifier: lowercase alphanumeric groups separated by single hyphens

country_codestring required

An ISO 3166-1 alpha-3 country code

validator_namestring nullable required

The name of the organization responsible for validating this project, if assigned

current_verifier_namestring nullable required

The name of the organization currently responsible for verifying this project, if assigned

crediting_period_startstring date nullable required
crediting_period_endstring date nullable required

Example response

{
  "id": "prj_1CTWZQGKE1S0VAXA",
  "supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "organisation": {
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric",
      "domain": "isometric.com"
    },
    "location": {
      "country_code": "GBR",
      "latitude": 51.5072,
      "longitude": -0.1276
    }
  },
  "short_code": "F5X7",
  "protocol_slug": "direct-air-capture",
  "protocol_data": {
    "slug": "direct-air-capture",
    "name": "Biochar Production and Storage",
    "baseline_version": "1.0",
    "current_version": "1.0"
  },
  "country_code": "GBR",
  "issued_credits_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "retired_credits_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "issued_buffer_pool_credits_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "retired_buffer_pool_credits_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "location": {
    "country_code": "GBR",
    "latitude": 51.5072,
    "longitude": -0.1276
  }
}