Skip to main content
GET
/
v1
/
search
Get a list of database footprints
curl --request GET \
  --url https://app.variable.global/api/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "count": 1500,
  "page": 1,
  "pageSize": 100,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Material Name",
      "description": "A descriptive description",
      "notes": "Internal notes about this product",
      "sku": "SKU123",
      "syncId": "sync123",
      "cpcCode": "CPC123",
      "unit": "kg",
      "weight": {
        "quantity": 100,
        "unit": "kg"
      },
      "packagingWeight": {
        "quantity": 10,
        "unit": "kg"
      },
      "recycledPercent": 30,
      "footprint": {
        "CO2e": {
          "A1": "1200.0",
          "A2": "30.0",
          "A3": "4.0",
          "A4": "0.5",
          "B1": "0.06",
          "B2": "0.007",
          "B3": "0.0008",
          "B4": "",
          "B5": "",
          "C1": "",
          "C2": "",
          "C3": "",
          "C4": "",
          "D": "",
          "totalCarbonFootprint": "1234.5678",
          "productCarbonFootprint": "1234.0",
          "upstream": "1230.0",
          "direct": "4.0",
          "downstream": "0.5678",
          "A1_A3": "1234.0"
        }
      },
      "dataQualityIndicators": {
        "documentationYear": 2019,
        "coveragePercent": 80,
        "specificPercent": 40,
        "technologicalDQR": 1,
        "temporalDQR": 1,
        "geographicalDQR": 1,
        "completenessDQR": 1,
        "reliabilityDQR": 1,
        "averagePercent": 60
      },
      "taxonomy": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Material",
        "path": "material"
      },
      "geoLocation": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Pittsburgh, PA"
      },
      "location": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Pittsburgh Office"
      },
      "startDate": "2021-01-01T00:00:00.000Z",
      "endDate": "2021-01-01T00:00:00.000Z",
      "dataSource": "model",
      "image": "https://app.variable.global/uploads/image.jpg",
      "modeledWeight": {
        "quantity": 100,
        "unit": "kg"
      },
      "modeledPackagingWeight": {
        "quantity": 12.5,
        "unit": "kg"
      },
      "modeledTotalWeight": {
        "quantity": 112.5,
        "unit": "kg"
      },
      "modeledRecycledPercent": 27.5,
      "impacts": {
        "GWP-fossil": {
          "unit": "kgCO2e",
          "method": "Mixed",
          "totalCarbonFootprint": "10",
          "A1_A3": "10"
        },
        "ODP": {
          "unit": "kgCFC11e",
          "method": "EN15804+A2 - Core impact categories and indicators",
          "A1_A3": "0.0000012"
        },
        "AP": {
          "unit": "molH+e",
          "method": "EN15804+A2 - Core impact categories and indicators",
          "A1_A3": "2"
        }
      },
      "dataQualityRating": 1.4,
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-31T23:59:59.000Z",
      "supplier": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "syncId": "sync123",
        "name": "Company Name"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string

The search term

Example:

"plastic"

​
unitType
string

The unit type

Example:

"volume"

​
taxonomy
string

The taxonomy UUID

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

​
source
string

The UUID of the supplier, database, etc.

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

​
impacts
string

Which environmental impact indicators to include in the impacts field. Absent or empty returns only GWP-fossil. Pass all for every indicator, or a comma-separated list of canonical codes to filter (case-insensitive). all is only honored on its own — combining it with other codes (e.g. all,gwp-fossil) is treated as an unknown code. An unknown code returns 400. See the Impacts concept and the full indicator catalog.

Example:

"gwp-fossil,odp,ap"

Response

A list of database footprints

​
count
integer
Example:

1500

​
page
integer
Example:

1

​
pageSize
integer
Example:

100

​
data
object[]