> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # List all Wishlists > Returns all wishlists available to the current user, in the current store. ## OpenAPI ````yaml /api-reference/storefront.yaml get /api/v2/storefront/wishlists openapi: 3.0.3 info: version: 2.0.0 title: Storefront API description: >- Storefront API is a modern REST API based on the [JSON API spec](https://jsonapi.org/) which provides you with all the necessary endpoints to build amazing user interfaces either in JavaScript frameworks or native mobile libraries. Import to [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml) contact: name: Vendo Connect Inc. url: https://spreecommerce.org email: hello@spreecommerce.org license: name: BSD-3-Clause url: https://github.com/spree/spree/blob/main/LICENSE.md servers: - url: https://demo.spreecommerce.org description: demo - url: http://localhost:3000 description: localhost security: [] tags: - name: Account - name: Account / Address - name: Account / Credit Cards - name: Account / Orders - name: Cart - name: Cart / Line Items - name: Cart / Coupons - name: Cart / Other - name: Checkout - name: Checkout / State - name: Checkout / Shipments - name: Checkout / Payments - name: Checkout / Store Credit - name: Stripe - name: Adyen - name: Countries - name: Digital Downloads - name: Order Status - name: Products - name: Variants - name: Stores - name: Policies - name: Taxons - name: Vendors - name: Wishlists - name: Wishlists / Wished Items paths: /api/v2/storefront/wishlists: get: tags: - Wishlists summary: List all Wishlists description: >- Returns all wishlists available to the current user, in the current store. operationId: list-wishlists-for-current-user parameters: - $ref: '#/components/parameters/WishlistIncludeParam' - $ref: '#/components/parameters/SparseFieldsWishlist' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/WishlistIsVariantIncludedParam' responses: '200': $ref: '#/components/responses/WishlistList' '403': $ref: '#/components/responses/403Forbidden' security: - bearerAuth: [] components: parameters: WishlistIncludeParam: name: include in: query schema: type: string example: wished_items.variant description: >- Specify the related resources you would like to receive in the `included` section of the response body. You can also retrieve related resources of included resources by using the dot notation, eg. `wished_items.variant`. [More information](https://jsonapi.org/format/#fetching-includes). SparseFieldsWishlist: in: query name: fields[wishlist] example: name,token,is_default,is_private,variant_included description: >- Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets). schema: type: string PerPageParam: name: per_page in: query description: Number of requested records per page when paginating collection schema: type: integer example: 25 WishlistIsVariantIncludedParam: name: is_variant_included in: query schema: type: string example: '150' description: >- Check for the presence of a variant in a wishlist by passing the variant ID, if the variant is present in the wishlist, the `variant_included` attribute will return `true` responses: WishlistList: description: 200 Success - Returns an array of `wishlist` objects. content: application/vnd.api+json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Wishlist' included: type: array items: $ref: '#/components/schemas/WishlistIncludes' meta: $ref: '#/components/schemas/ListMeta' links: $ref: '#/components/schemas/ListLinks' required: - data - meta - links examples: List of Wishlist's: value: data: - id: '4' type: wishlist attributes: token: gD1QP6SybtooojnxtkXPvcvh name: My Wishlist is_private: false is_default: false variant_included: true relationships: wished_items: data: - id: '4' type: wished_item - id: '5' type: wished_item - id: '8' type: wishlist attributes: token: LKWCxupq2gsN9DRhwuNBCrf5 name: Fathers Day is_private: true is_default: true variant_included: false relationships: wished_items: data: - id: '6' type: wished_item - id: '7' type: wishlist attributes: token: QHnjcCvz21Dtzc6isWyiyBxM name: Black Friday is_private: false is_default: false variant_included: false relationships: wished_items: data: [] meta: count: 3 total_count: 3 total_pages: 1 links: self: >- http://localhost:3000/api/v2/storefront/wishlists?is_variant_included=150 next: http://localhost:3000/api/v2/storefront/wishlists?page=1 prev: http://localhost:3000/api/v2/storefront/wishlists?page=1 last: http://localhost:3000/api/v2/storefront/wishlists?page=1 first: http://localhost:3000/api/v2/storefront/wishlists?page=1 403Forbidden: description: 403 Forbidden - You are not authorized to access this page. content: application/vnd.api+json: schema: properties: error: type: string example: You are not authorized to access this page. default: You are not authorized to access this page. examples: 403 Example: value: error: You are not authorized to access this page. schemas: Wishlist: description: '' type: object title: Wishlist x-internal: false properties: id: type: string type: type: string default: wishlist attributes: type: object properties: token: type: string name: type: string is_private: type: boolean is_default: type: boolean variant_included: type: boolean description: >- Returns `true` or `false` depending on the variant ID passed in through the `is_variant_included` query param. relationships: type: object properties: wished_items: type: object properties: data: type: array items: allOf: - $ref: '#/components/schemas/Relation' required: - id - type - attributes - relationships WishlistIncludes: x-internal: false title: Wishlist Includes allOf: - $ref: '#/components/schemas/WishedItem' ListMeta: type: object x-internal: false title: Pagination Meta properties: count: type: number example: 7 description: Number of items on the current listing total_count: type: number example: 145 description: Number of all items matching the criteria total_pages: type: number example: 10 description: Number of all pages containing items matching the criteria ListLinks: x-internal: false type: object title: Pagination Links properties: self: type: string description: URL to the current page of the listing next: type: string description: URL to the next page of the listing prev: type: string description: URL to the previous page of the listing last: type: string description: URL to the last page of the listing first: type: string description: URL to the first page of the listing Relation: type: object nullable: true properties: id: type: string type: type: string required: - id - type x-internal: false description: '' WishedItem: type: object x-internal: false properties: id: type: string type: type: string default: wished_item attributes: type: object properties: quantity: type: integer price: type: string total: type: string display_price: type: string display_total: type: string relationships: type: object properties: variant: type: object properties: data: $ref: '#/components/schemas/Relation' required: - id - type - attributes - relationships securitySchemes: bearerAuth: type: http scheme: bearer description: |- User token to authorize Cart and Checkout requests. It is required to associate Cart with the User. ````