Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.heffl.com/api/v2/products \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "type": "<string>",
      "isActive": true,
      "description": "<string>",
      "sku": "<string>"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

cursor
string

Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.

limit
integer
default:20

Number of items to return (max 100)

Required range: 1 <= x <= 100

Search by product name

includeInactive
boolean

Include inactive products in the response

Response

OK

data
object[]
required
meta
object
required