HostMentor Docs

List products

GET/{catalog_id}/products

Returns the products in your catalog. Use filter to search, fields to choose what's returned, and after to page through.

Authorization

apiKey
apikey<token>

Your HostMentor API key, from the dashboard under Messaging → WhatsApp → API keys.

In: header

Path Parameters

catalog_id*string

ID of your product catalog, from Retrieve your catalog ID.

Query Parameters

fields?string

Fields to return, as a JSON list.

filter?string

A JSON search filter, such as products whose name contains a word.

summary?boolean

Include the total number of products.

limit?integer

Products per page.

after?string

Cursor for the next page.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://wa.hostmentor.com/v3/801262455316921/products?fields=%5B%22retailer_id%22%2C%22name%22%2C%22price%22%2C%22availability%22%2C%22image_url%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22t-shirt%22%7D%7D&limit=25" \  -H "apikey: YOUR_API_KEY"
{  "data": [    {      "id": "7241836912544032",      "retailer_id": "tshirt-blue-m",      "name": "Blue T-shirt (M)",      "price": "₹499.00",      "availability": "in stock",      "image_url": "https://example.com/images/tshirt-blue.jpg"    }  ],  "paging": {    "cursors": {      "before": "QVFIUmxtNVRpSjJ",      "after": "QVFIUlZAPOEdrMVJ"    }  }}