Skip to main content
POST
/
components
/
search
Get Components List
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/components/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "ids": [
    "<string>"
  ],
  "textSearch": "<string>"
}
'
{
  "from": 123,
  "size": 123,
  "total": 123,
  "results": [
    {
      "_id": "<string>",
      "name": "<string>"
    }
  ]
}
Use this endpoint to search the component catalog. Components represent additional product elements such as buttons, zippers, and trims that contribute to a product’s environmental impact.

​
Request body params

Field NameData TypeDescription
textSearchstringSearch components by name.
idsArray<string>Filter by specific component IDs.
fromnumber[DEFAULT: 0] Pagination start index.
sizenumber[DEFAULT: 50] Number of results to return (max 50).
sortobjectSorting configuration { field: string, order: "asc" | "desc" }.

​
Implementation Details

  • Pagination: Maximum page size is capped at 50 results.
  • Usage: Use the returned _id values (as componentId) in the components array when creating or updating products.

Authorizations

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

Body

application/json
​
from
number<double> | null
​
size
number<double> | null
​
ids
string[] | null
​
sort
object

API Search requests

​
textSearch
string | null

Response

200 - application/json

Ok

API Search responses

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