Skip to main content
POST
/
material-library
/
base-material-list
Get Base Material Library List
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "filter": {
    "logic": "<string>",
    "filters": [
      {
        "field": "<string>",
        "operator": "<string>",
        "value": {}
      }
    ]
  },
  "skip": 123,
  "take": 123,
  "sort": [
    {
      "field": "<string>",
      "dir": "<string>",
      "isNotNested": true
    }
  ],
  "searchStr": "<string>"
}
'
{
  "total": 123,
  "hits": [
    {
      "_id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "code": "<string>",
      "category": "<string>",
      "cycles": {},
      "scores": {
        "globalWarming": 123,
        "eutrophication": 123,
        "waterScarcity": 123,
        "abioticDepletion": 123,
        "chemistry": 123,
        "globalWarmingPts": 123,
        "eutrophicationPts": 123,
        "waterScarcityPts": 123,
        "abioticDepletionPts": 123,
        "impact": 123,
        "chemistryPts": 123,
        "waterConsumption": 123,
        "biogenicCarbon": 123
      },
      "_rev": "<string>",
      "hidden": true,
      "blendPercentage": 123,
      "categoryRanking": 123,
      "totalScoresTier2": 123,
      "totalScoresTier3": 123,
      "totalScoresTier4": 123,
      "finishedMaterialChemCertsAvailable": [
        "bluesignCertified"
      ],
      "finishedMaterialChemCertsSelected": [
        "bluesignCertified"
      ]
    }
  ],
  "aggregations": {}
}
Use this endpoint to browse the base material catalog. Base materials are the raw material building blocks (e.g., cotton, polyester, nylon) that you use when creating custom materials in the material library.

Implementation Details

  • Textile category: Results are filtered to the textile (TX) category by default.
  • Searchable: Supports text search and standard filtering parameters (skip, take, sort, filter) for advanced queries.
  • Usage: Use the returned base material IDs in the baseMaterials array when creating a custom material.

Authorizations

x-api-key
string
header
required
x-developer-request-token
string
header
required

Body

application/json
filter
object
skip
number<double> | null
take
number<double> | null
sort
object[] | null
searchStr
string | null

Response

200 - application/json

Ok

total
number<double>
required
hits
object[]
required
aggregations
object