GET
/
pact
/
2
/
footprint
/
:id
curl --request GET \
  --url https://app.variable.global/api/pact/2/footprint/:id \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "specVersion": "2.1.0",
    "precedingPfIds": [
      "<any>"
    ],
    "version": 1,
    "status": "Active",
    "statusComment": "<string>",
    "validityPeriodStart": "2023-11-07T05:31:56Z",
    "validityPeriodEnd": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "companyIds": [
      "<any>"
    ],
    "productIds": [
      "<any>"
    ],
    "productCategoryCpc": "<string>",
    "productNameCompany": "<string>",
    "productDescription": "<string>",
    "comment": "<string>",
    "pcf": {
      "declaredUnit": "kilogram",
      "unitaryProductAmount": 1234.5678,
      "pCfExcludingBiogenic": 1234.5678,
      "pCfIncludingBiogenic": 1234.5678,
      "fossilGhgEmissions": 1234.5678,
      "fossilCarbonContent": 1234.5678,
      "biogenicCarbonContent": 1234.5678,
      "dLucGhgEmissions": 1234.5678,
      "landManagementGhgEmissions": 1234.5678,
      "otherBiogenicGhgEmissions": 1234.5678,
      "iLucGhgEmissions": 1234.5678,
      "biogenicCarbonWithdrawal": 1234.5678,
      "aircraftGhgEmissions": 1234.5678,
      "characterizationFactors": "AR6",
      "ipccCharacterizationFactorsSources": [
        "AR6"
      ],
      "crossSectoralStandardsUsed": [
        "GHG Protocol Product standard"
      ],
      "productOrSectorSpecificRules": [
        "<any>"
      ],
      "biogenicAccountingMethodology": "GHGP",
      "boundaryProcessesDescription": "<string>",
      "referencePeriodStart": "2023-11-07T05:31:56Z",
      "referencePeriodEnd": "2023-11-07T05:31:56Z",
      "geographyCountrySubdivision": "US-PA",
      "geographyCountry": "NO",
      "geographyRegionOrSubregion": "Europe",
      "secondaryEmissionFactorSources": [
        "<any>"
      ],
      "exemptedEmissionsPercent": 2,
      "exemptedEmissionsDescription": "<string>",
      "packagingEmissionsIncluded": true,
      "packagingGhgEmissions": 1234.5678,
      "allocationRulesDescription": "<string>",
      "uncertaintyAssessmentDescription": "<string>",
      "primaryDataShare": 82,
      "dqi": {
        "coveragePercent": 80,
        "technologicalDQR": 2,
        "temporalDQR": 2,
        "geographicalDQR": 2,
        "completenessDQR": 2,
        "reliabilityDQR": 2
      }
    },
    "extensions": [
      "<any>"
    ],
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
}

The path is relative to your company specific url:

https://your_subdomain.variable.global/api

Only footprints that are valid according to the PACT standard will show in the API, regardless of the sharing setting.

This generally means footprints that have all of the required fields filled out. Details on the PACT standard and required fields can be found in the PACT documentation.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json

A Product Carbon Footprint

The response is of type object.

GET
/
pact
/
2
/
footprint
/
:id
curl --request GET \
  --url https://app.variable.global/api/pact/2/footprint/:id \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "specVersion": "2.1.0",
    "precedingPfIds": [
      "<any>"
    ],
    "version": 1,
    "status": "Active",
    "statusComment": "<string>",
    "validityPeriodStart": "2023-11-07T05:31:56Z",
    "validityPeriodEnd": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "companyIds": [
      "<any>"
    ],
    "productIds": [
      "<any>"
    ],
    "productCategoryCpc": "<string>",
    "productNameCompany": "<string>",
    "productDescription": "<string>",
    "comment": "<string>",
    "pcf": {
      "declaredUnit": "kilogram",
      "unitaryProductAmount": 1234.5678,
      "pCfExcludingBiogenic": 1234.5678,
      "pCfIncludingBiogenic": 1234.5678,
      "fossilGhgEmissions": 1234.5678,
      "fossilCarbonContent": 1234.5678,
      "biogenicCarbonContent": 1234.5678,
      "dLucGhgEmissions": 1234.5678,
      "landManagementGhgEmissions": 1234.5678,
      "otherBiogenicGhgEmissions": 1234.5678,
      "iLucGhgEmissions": 1234.5678,
      "biogenicCarbonWithdrawal": 1234.5678,
      "aircraftGhgEmissions": 1234.5678,
      "characterizationFactors": "AR6",
      "ipccCharacterizationFactorsSources": [
        "AR6"
      ],
      "crossSectoralStandardsUsed": [
        "GHG Protocol Product standard"
      ],
      "productOrSectorSpecificRules": [
        "<any>"
      ],
      "biogenicAccountingMethodology": "GHGP",
      "boundaryProcessesDescription": "<string>",
      "referencePeriodStart": "2023-11-07T05:31:56Z",
      "referencePeriodEnd": "2023-11-07T05:31:56Z",
      "geographyCountrySubdivision": "US-PA",
      "geographyCountry": "NO",
      "geographyRegionOrSubregion": "Europe",
      "secondaryEmissionFactorSources": [
        "<any>"
      ],
      "exemptedEmissionsPercent": 2,
      "exemptedEmissionsDescription": "<string>",
      "packagingEmissionsIncluded": true,
      "packagingGhgEmissions": 1234.5678,
      "allocationRulesDescription": "<string>",
      "uncertaintyAssessmentDescription": "<string>",
      "primaryDataShare": 82,
      "dqi": {
        "coveragePercent": 80,
        "technologicalDQR": 2,
        "temporalDQR": 2,
        "geographicalDQR": 2,
        "completenessDQR": 2,
        "reliabilityDQR": 2
      }
    },
    "extensions": [
      "<any>"
    ],
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
}

The path is relative to your company specific url:

https://your_subdomain.variable.global/api

Only footprints that are valid according to the PACT standard will show in the API, regardless of the sharing setting.

This generally means footprints that have all of the required fields filled out. Details on the PACT standard and required fields can be found in the PACT documentation.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json

A Product Carbon Footprint

The response is of type object.