v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Get Components

Lists components in the Isometric system

get/components

Query parameters

supplier_reference_idstring nullable

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

scope'REMOVAL' | 'GHG_STATEMENT' | 'PROJECT' | 'NET_NEGATIVITY'
ghg_statement_idstring
Example:ggs_1GDQJ99Z51S0DYW9
project_idstring
Example:prj_1CTWZQGKE1S0VAXA
ghg_entry_idstring
Example:rmv_1EEM6NJXX1S0EXKD
removal_idstring
Example:rmv_1EEM6NJXX1S0EXKD
lastinteger

An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.

beforestring nullable

An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.

firstinteger

An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.

afterstring nullable

An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.

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

total_countinteger required

Example response

{
  "nodes": [
    {
      "id": "cmp_1EP2SB7MZ1S036PY",
      "removal_template_component_id": "rtc_1DAA58EDM1S0AMPN",
      "ghg_entry_template_component_id": "rtc_1DAA58EDM1S0AMPN",
      "inputs": [
        {
          "datapoint_ids": [
            "dtp_1DVKHKS101S0Q61Q"
          ]
        }
      ]
    }
  ]
}