List Materials

Get a list of materials

curl --request GET \
  --url https://app.variable.global/api/v1/material \
  --header 'Authorization: Bearer <token>'

{
  "count": 1500,
  "page": 1,
  "pageSize": 100,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Material Name",
      "dataSource": "model",
      "description": "A descriptive description",
      "sku": "SKU123",
      "syncId": "sync123",
      "cpcCode": "CPC123",
      "unit": "kg",
      "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,
        "geographicalDQR": 1,
        "completenessDQR": 1,
        "reliabilityDQR": 1,
        "averagePercent": 60,
        "temporalDQR": 3
      },
      "taxonomy": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Material",
        "slug": "electricity",
        "path": "energy/electricity"
      },
      "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",
      "image": "https://app.variable.global/uploads/image.jpg",
      "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"
      }
    }
  ]
}

GET

material

Get a list of materials

curl --request GET \
  --url https://app.variable.global/api/v1/material \
  --header 'Authorization: Bearer <token>'

{
  "count": 1500,
  "page": 1,
  "pageSize": 100,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Material Name",
      "dataSource": "model",
      "description": "A descriptive description",
      "sku": "SKU123",
      "syncId": "sync123",
      "cpcCode": "CPC123",
      "unit": "kg",
      "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,
        "geographicalDQR": 1,
        "completenessDQR": 1,
        "reliabilityDQR": 1,
        "averagePercent": 60,
        "temporalDQR": 3
      },
      "taxonomy": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Material",
        "slug": "electricity",
        "path": "energy/electricity"
      },
      "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",
      "image": "https://app.variable.global/uploads/image.jpg",
      "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"
      }
    }
  ]
}

Requires permission:

Read more about the Material data model.

Authorizations

Authorization

string

header

required

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

Response

A list of materials

count

integer

Example:

1500

page

integer

Example:

1

pageSize

integer

Example:

100

data

object[]

Show child attributes

data.uuid

string<UUID>

data.name

string

Example:

"Material Name"

data.dataSource

enum<string>

Available options:

model,

external,

database

Example:

"model"

data.description

string

Example:

"A descriptive description"

data.sku

string

Example:

"SKU123"

data.syncId

string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

data.cpcCode

string

Example:

"CPC123"

data.unit

string

The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.

Example:

"kg"

data.footprint

object

Using dataSource: external allows setting certain footprint.CO2e values. The values are computed all other dataSources.

Show child attributes

data.footprint.CO2e

object

Show child attributes

data.footprint.CO2e.A1

string

Example:

"1200.0"

data.footprint.CO2e.A2

string

Example:

"30.0"

data.footprint.CO2e.A3

string

Example:

"4.0"

data.footprint.CO2e.A4

string

Example:

"0.5"

data.footprint.CO2e.B1

string

Example:

"0.06"

data.footprint.CO2e.B2

string

Example:

"0.007"

data.footprint.CO2e.B3

string

Example:

"0.0008"

data.footprint.CO2e.B4

string

Example:

""

data.footprint.CO2e.B5

string

Example:

""

data.footprint.CO2e.C1

string

Example:

""

data.footprint.CO2e.C2

string

Example:

""

data.footprint.CO2e.C3

string

Example:

""

data.footprint.CO2e.C4

string

Example:

""

data.footprint.CO2e.D

string

Example:

""

data.footprint.CO2e.totalCarbonFootprint

string

Example:

"1234.5678"

data.footprint.CO2e.productCarbonFootprint

string

Example:

"1234.0"

data.footprint.CO2e.upstream

string

Example:

"1230.0"

data.footprint.CO2e.direct

string

Example:

"4.0"

data.footprint.CO2e.downstream

string

Example:

"0.5678"

data.footprint.CO2e.A1_A3

string

Example:

"1234.0"

data.dataQualityIndicators

object

Show child attributes

data.dataQualityIndicators.documentationYear

number

Example:

2019

data.dataQualityIndicators.coveragePercent

number

Example:

80

data.dataQualityIndicators.specificPercent

number

Example:

40

data.dataQualityIndicators.technologicalDQR

number

Example:

1

data.dataQualityIndicators.geographicalDQR

number

Example:

1

data.dataQualityIndicators.completenessDQR

number

Example:

1

data.dataQualityIndicators.reliabilityDQR

number

Example:

1

data.dataQualityIndicators.averagePercent

number

Example:

60

data.dataQualityIndicators.temporalDQR

number

This is calculated based on the documentationYear
1 = this year (2024)
2 = previous 4 years (2020 - 2023)
3 = 5+ years old (2019 and older)

Example:

3

data.taxonomy

object

Show child attributes

data.taxonomy.uuid

string<UUID>

data.taxonomy.name

string

Example:

"Material"

data.taxonomy.slug

string

Example:

"electricity"

data.taxonomy.path

string

Example:

"energy/electricity"

data.geoLocation

object

Show child attributes

data.geoLocation.uuid

string<UUID>

data.geoLocation.name

string

Example:

"Pittsburgh, PA"

data.location

object

Show child attributes

data.location.uuid

string<UUID>

data.location.name

string

Example:

"Pittsburgh Office"

data.startDate

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

data.endDate

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

data.image

string

Example:

"https://app.variable.global/uploads/image.jpg"

data.dataQualityRating

number

Example:

1.4

data.created

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

data.updated

string

ISO 8601 date

Example:

"2021-01-31T23:59:59.000Z"

data.supplier

object

Show child attributes

data.supplier.uuid

string<UUID>

data.supplier.syncId

string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

data.supplier.name

string

Example:

"Company Name"

Delete Product Get Material

⌘I

Getting Started

Auth Token

Database

Product

Material

Model

Switch

Supplier

Activity

Org

Scope

Taxonomy

Unit

Authorizations

Response