GET
/
projects
/
{id}
curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'
{
  "country_code": "GBR",
  "crediting_period_end": "2023-11-07T05:31:56Z",
  "crediting_period_start": "2023-11-07T05:31:56Z",
  "facilities": [
    {
      "description": "<string>",
      "name": "<string>"
    }
  ],
  "id": "prj_1CTWZQGKE1S0VAXA",
  "issued_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "issued_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "name": "<string>",
  "pathway": "biomass_carbon_removal_and_storage",
  "process_key": "<string>",
  "retired_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "retired_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "short_code": "F5X7",
  "status": "draft",
  "supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "location": {
      "country_code": "<string>",
      "country_name": "<string>"
    },
    "organisation": {
      "domain": "isometric.com",
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric"
    }
  },
  "url": "<string>",
  "validator_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required

Response

200
application/json
Successful Response
​
country_code
string
required

A three letter ISO 3166-1 alpha-3 code representing a country

Example:

"GBR"

​
crediting_period_end
string | null
required
​
crediting_period_start
string | null
required
​
facilities
object[]
required

Any facilities linked to this project

​
id
string
required
Required string length: 20 - 36
Example:

"prj_1CTWZQGKE1S0VAXA"

​
issued_buffer_pool_credits_total
object
required

The total number of credits from this project that have been allocated to the supplier's buffer pool

​
issued_credits_total
object
required

The total number of credits Isometric has issued to this project, including those allocated to the buffer pool

​
name
string
required
​
pathway
enum<string>
required

The pathway this project is following

Available options:
biomass_carbon_removal_and_storage,
direct_air_capture,
enhanced_weathering,
carbon_mineralization,
reforestation,
oceans_and_rivers
​
process_key
string
required

The carbon removal process used in this project

​
retired_buffer_pool_credits_total
object
required

The total number of credits from this project that have been retired from the supplier's buffer pool

​
retired_credits_total
object
required

The total number of credits from this project that have been retired, including those allocated to the buffer pool

​
short_code
string
required

A random short code, uniquely identifying the project

Example:

"F5X7"

​
status
enum<string>
required

The project status

Available options:
draft,
preview,
under_validation,
validated,
closed
​
supplier
object
required
​
url
string
required

The url to the Isometric page for this project

​
validator_name
string | null
required

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

Was this page helpful?