Skip to main content
POST
/
higg-index
/
pm
/
search
Search Pm
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/higg-index/pm/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "accountId": "<string>",
  "certifications": [
    "<string>"
  ],
  "claimsStatus": "<string>",
  "claimsLevel": 123,
  "claimsExpires": "<string>",
  "higgId": 123,
  "name": "<string>",
  "productStyleNumber": "<string>",
  "productType": "Apparel",
  "productCategory": {},
  "createdAfter": "2023-11-07T05:31:56Z",
  "createdBefore": "2023-11-07T05:31:56Z",
  "lastEditedAfter": "2023-11-07T05:31:56Z",
  "lastEditedBefore": "2023-11-07T05:31:56Z",
  "platformModifiedBy": "User",
  "platformCreatedBy": "User",
  "productLastEditedBefore": "2023-11-07T05:31:56Z",
  "productLastEditedAfter": "2023-11-07T05:31:56Z",
  "submittedBefore": "2023-11-07T05:31:56Z",
  "submittedAfter": "2023-11-07T05:31:56Z",
  "barcodes": [
    "<string>"
  ],
  "claimType": "Materials",
  "from": 123,
  "size": 123
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "_id": "<string>",
      "created_on": 123,
      "name": "<string>",
      "productType": "Apparel",
      "productCategory": {},
      "userEmail": "<string>",
      "draft": true,
      "grossWeight": 123,
      "last_edit": 123,
      "modelNumber": "<string>",
      "platformModifiedBy": "User",
      "platformCreatedBy": "User",
      "barcodes": [
        "<string>"
      ],
      "productNetWeight": 123,
      "bomNetWeight": 123
    }
  ]
}
Use this endpoint to search your Higg Product Module (PM) entries. Product Module objects contain detailed product-level sustainability data and can be referenced when creating PIC products.

​
Request body params

Field NameData TypeDescription
namestringFilter PM entries by name.
idsArray<string>Filter by specific PM IDs.
fromnumber[DEFAULT: 0] Pagination start index.
sizenumber[DEFAULT: 50] Number of results to return.

​
Implementation Details

  • Published only: Only non-draft Product Module entries are returned.
  • Pagination: Standard pagination using from and size with a default of 50 results.
  • Additional filters: The full request schema supports additional filter parameters beyond those listed above (e.g., certifications, productType, date ranges). See the API playground for the complete schema.

Authorizations

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

Body

application/json

MSI & PM Search requests

​
ids
string[] | null
​
accountId
string | null
​
certifications
string[] | null
​
claimsStatus
string | null
​
claimsLevel
number<double> | null
​
claimsExpires
string | null
​
higgId
number<double> | null
​
name
string | null
​
productStyleNumber
string | null
​
productType
enum<string>
Available options:
Apparel,
Footwear,
HomeTextiles,
Other
​
productCategory
object
​
createdAfter
string<date-time> | null
​
createdBefore
string<date-time> | null
​
lastEditedAfter
string<date-time> | null
​
lastEditedBefore
string<date-time> | null
​
platformModifiedBy
enum<string>
Available options:
User,
Api
​
platformCreatedBy
enum<string>
Available options:
User,
Api
​
productLastEditedBefore
string<date-time> | null
​
productLastEditedAfter
string<date-time> | null
​
submittedBefore
string<date-time> | null
​
submittedAfter
string<date-time> | null
​
barcodes
string[] | null
​
claimType
enum<string>
Available options:
Materials,
Disclosure
​
from
number<double> | null
​
size
number<double> | null

Response

200 - application/json

Ok

API Search responses

​
from
number<double>
required
​
size
number<double>
required
​
total
number<double>
required
​
results
object[]
required