← Documentation home
GET/hyax-api/v1/products

List products

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

NameRequiredDescription
limitNoDefault 25, max 100
offsetNoDefault 0
typeNo`DIGITAL` | `PHYSICAL` | `COURSE` | `EVENT` | `MEETING` | `MEMBERSHIP`
isActiveNo`true` | `false`
archivedNo`true` to list archived products only (default: active catalog)
searchNoSearch title, slug, or description

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/products?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "title": "Pro plan",
      "slug": "pro-plan",
      "description": null,
      "type": "MEMBERSHIP",
      "pricingType": "ONE_TIME",
      "price": 99,
      "currency": "USD",
      "isActive": true,
      "isArchived": false,
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z"
    }
  ],
  "pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}