# Retrieve a list of wine clubs

🚦 Rate Limit: 100 requests / minute

Endpoint: GET /wine-clubs
Version: 1.2.0
Security: BearerAuth

## Query parameters:

  - `offset` (integer)
    Number of records to skip for pagination (default: 0)

  - `pageSize` (integer)
    Number of records to return per page (default: 1000, max: 1000)
    Example: 50

## Response 200 fields (application/json):

  - `data` (array)

  - `data.wine_club_name` (string)
    Example: "Black Lodge Reserve"

  - `data.short_description` (string)
    Example: "Exclusive, limited-release wines from the mysterious Black Lodge collection."

  - `data.long_description` (string)
    Example: "Members receive carefully curated wines from our most enigmatic vineyards—each bottle tells a story of the supernatural and the sublime. Includes exclusive tasting notes and pairing suggestions."

  - `data.number_of_shipment` (string)
    Example: "4"

  - `data.frequency` (string)
    Example: "quarterly"

  - `data.open_before_n_days` (integer)
    Example: 21

  - `data.close_after_n_days` (integer)
    Example: 7

  - `data.price_range` (string)
    Example: "$220 – $280"

  - `data.status` (string)
    Example: "active"

  - `data.publish_date` (string)
    Example: "2024-11-01T00:00:00Z"

  - `data.created_at` (string)
    Example: "2023-08-15T10:21:37Z"

  - `data.default_shipping_rate` (number)
    Example: 28

  - `data.active_members` (integer)
    Example: 156

  - `data.paused_members` (integer)
    Example: 12

  - `data.cancelled_members` (integer)
    Example: 23

  - `data.packages` (array)

  - `data.packages.package_id` (string)
    Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  - `data.packages.package_number` (integer)
    Example: 2025001

  - `data.packages.package_type` (string)
    Example: "red_wine"

  - `data.packages.payment_date` (string)
    Example: "2025-01-15T00:00:00Z"

  - `data.packages.opened_at` (string)
    Example: "2025-01-01T00:00:00Z"

  - `data.packages.closed_at` (string)
    Example: "2025-01-31T23:59:59Z"

  - `data.packages.products` (array)

  - `data.packages.products.variant_id` (string)
    Example: "f4a71b9d-17a9-4100-8110-46e133d6fc1b"

  - `data.packages.products.product_name` (string)
    Example: "Black Lodge Chardonnay 2022"

  - `data.packages.products.sku` (string)
    Example: "BL-CHA-2022-750"

  - `data.packages.products.default_quantity` (integer)
    Example: 2

  - `data.packages.products.min_quantity` (integer)
    Example: 1

  - `data.packages.products.max_quantity` (integer)
    Example: 6

  - `pagination` (object)

  - `pagination.current_offset` (integer)

  - `pagination.page_size` (integer)
    Example: 50

  - `pagination.total_records` (integer)
    Example: 1250

  - `pagination.total_pages` (integer)
    Example: 25

  - `pagination.current_page` (integer)
    Example: 1

  - `pagination.pages_remaining` (integer)
    Example: 24

  - `pagination.has_next_page` (boolean)
    Example: true

  - `pagination.has_previous_page` (boolean)