> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wizcommerce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List wishlists

> List wishlists, most recently updated first. Filter by wishlist IDs, customer, type, or by when they were created or updated. Each wishlist carries its item count; call Get Wishlist for the products on it.



## OpenAPI

````yaml get /v2/wishlists
openapi: 3.1.0
info:
  description: Client-facing Open APIs for WizCommerce
  title: WizCommerce Open API's
  termsOfService: https://wizcommerce.com/terms/
  contact:
    name: Tech Support
    url: https://help.wizcommerce.com/
    email: tech@wizcommerce.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
servers:
  - url: https://api.wizcommerce.com
    description: Production BaseURL
  - url: https://api-staging.sourcerer.tech
    description: Staging BaseURL
security: []
paths:
  /v2/wishlists:
    get:
      tags:
        - Wishlists
      summary: List wishlists
      description: >-
        List wishlists, most recently updated first. Filter by wishlist IDs,
        customer, type, or by when they were created or updated. Each wishlist
        carries its item count; call Get Wishlist for the products on it.
      parameters:
        - example: 1
          x-order: '1'
          name: page
          in: query
          schema:
            type: integer
            minimum: 1
        - example: 25
          x-order: '2'
          name: page_size
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - example: '2021-01-01T00:00:00Z'
          x-order: '3'
          description: 'format: 2006-01-02T15:04:05Z (ISO 8601) UTC'
          name: created_after
          in: query
          schema:
            type: string
        - example: '2021-01-01T00:00:00Z'
          x-order: '4'
          description: 'format: 2006-01-02T15:04:05Z (ISO 8601) UTC'
          name: created_before
          in: query
          schema:
            type: string
        - example: '2021-01-01T00:00:00Z'
          x-order: '5'
          description: 'format: 2006-01-02T15:04:05Z (ISO 8601) UTC'
          name: updated_after
          in: query
          schema:
            type: string
        - example: '2021-01-01T00:00:00Z'
          x-order: '6'
          description: 'format: 2006-01-02T15:04:05Z (ISO 8601) UTC'
          name: updated_before
          in: query
          schema:
            type: string
        - example:
            - 5d0b2f63-7f8e-4f0c-9d41-3c4f0f6b2a17
          x-order: '7'
          description: >-
            Filter by wishlist IDs. Repeat param for multiple:
            ?ids=<uuid>&ids=<uuid>.
          name: ids
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - example: 4bd02cd3-06d2-498a-9749-b4f87faeccd7
          x-order: '8'
          description: Wishlists kept for this customer.
          name: customer_id
          in: query
          schema:
            type: string
        - example: buyer
          x-order: '9'
          description: 'buyer: kept for a customer. self: a user''s own list.'
          name: type
          in: query
          schema:
            type: string
            enum:
              - buyer
              - self
        - example: updated_at
          x-order: '10'
          name: sort_by
          in: query
          schema:
            type: string
            enum:
              - created_at
              - updated_at
        - example: desc
          x-order: '11'
          name: sort
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dtos.SuccessPaginationResponse'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/dtos.WishlistListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.HttpError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    dtos.SuccessPaginationResponse:
      type: object
      properties:
        data:
          x-order: '1'
        pagination:
          allOf:
            - $ref: '#/components/schemas/dtos.PaginationResponse'
          x-order: '2'
    dtos.WishlistListResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 5d0b2f63-7f8e-4f0c-9d41-3c4f0f6b2a17
        name:
          type: string
          x-order: '2'
          example: Spring Showroom Picks
        type:
          description: 'buyer: kept for a customer. self: a user''s own list.'
          type: string
          enum:
            - buyer
            - self
          x-order: '3'
          example: buyer
        customer_id:
          type: string
          x-order: '4'
          example: 4bd02cd3-06d2-498a-9749-b4f87faeccd7
        customer_name:
          description: Company name; null when the wishlist has no customer.
          type: string
          x-order: '5'
          example: Acme Interiors
        is_promoted:
          description: Promoted to sales reps by an admin.
          type: boolean
          x-order: '6'
          example: false
        total_items:
          description: Number of published product variants on the wishlist.
          type: integer
          x-order: '7'
          example: 2
        created_by:
          allOf:
            - $ref: '#/components/schemas/dtosv2.UserInfoResponse'
          x-order: '8'
        updated_by:
          allOf:
            - $ref: '#/components/schemas/dtosv2.UserInfoResponse'
          x-order: '9'
        created_at:
          type: string
          x-order: '10'
          example: '2026-10-01T12:00:00Z'
        updated_at:
          type: string
          x-order: '11'
          example: '2026-10-09T08:52:27Z'
    errors.HttpError:
      type: object
      properties:
        code:
          type: string
          x-order: '1'
        message:
          type: string
          x-order: '2'
        details:
          type: array
          items:
            $ref: '#/components/schemas/errors.HttpErrorDetails'
          x-order: '3'
    dtos.PaginationResponse:
      type: object
      properties:
        total_records:
          type: integer
          x-order: '1'
          example: 100
        total_pages:
          type: integer
          x-order: '2'
          example: 10
        current_page:
          type: integer
          x-order: '3'
          example: 1
        next_page:
          type: integer
          x-order: '4'
          example: 2
        prev_page:
          type: integer
          x-order: '5'
          example: 0
        page_size:
          type: integer
          x-order: '6'
          example: 10
    dtosv2.UserInfoResponse:
      type: object
      properties:
        id:
          type: string
          x-order: '1'
          example: 01f5d171-d3e3-4b2b-bd57-0727194b5bed
        email:
          type: string
          x-order: '2'
          example: user@example.com
    errors.HttpErrorDetails:
      type: object
      properties:
        field:
          type: string
          x-order: '1'
        reason:
          type: string
          x-order: '2'
  securitySchemes:
    ApiKeyAuth:
      description: API Key for authentication
      type: apiKey
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.