> For the complete documentation index, see [llms.txt](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/wishlist-rest-api/wishlists/getwishlist.md).

# getWishlist

Retrieves the wishlist and the wishlist items that belongs to the given ***wishlistId*** or ***wishlistRef***. If the wishlist does not exist, this method returns a ResourceNotFound error.

The returned item array is paginated - 50 default (50 maximum). The API will respond with the item count in the page, and the itemID the for the last item (lastitemID) returned for that response, which should then be used for the subsequent API call to retrieve the next page.

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"tags":[{"name":"wishlists","description":"Create, read, update and delete wishlists, and look them up by id, reference or customer."}],"servers":[{"url":"https://api.au-aws.thewishlist.io/services/wsservice"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token issued by TWC Keycloak, sent as `Bearer <token>`."}},"parameters":{"X-TWC-Tenant-2":{"name":"X-TWC-Tenant","in":"header","required":false,"description":"tenant-key (your retail store's unique identifier in TWC)","schema":{"type":"string"}},"lastItemId":{"name":"lastItemId","in":"query","required":false,"description":"Determines which items to return. API returns wishlist items in the ascending order of their TWC generated wishlist ID. This parameter will inform the API to respond with items that have ID greater than, but excluding the value provided.","schema":{"type":"string"}}},"schemas":{"WishlistDto":{"type":"object","properties":{"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"customerId":{"type":"string"},"customerRef":{"type":"string"},"deleted":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"isPrivate":{"type":"boolean"},"itemCount":{"type":"integer","format":"int32"},"lastEvaluatedItemId":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"wishlistItems":{"type":"array","items":{"$ref":"#/components/schemas/WishlistItemDto"}},"wishlistRef":{"type":"string"}},"title":"WishlistDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"WishlistItemDto":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"datePurchased":{"type":"string","format":"date-time"},"disableNotification":{"type":"boolean"},"id":{"type":"string"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ProductDto"},"purchased":{"type":"boolean"},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}},"title":"WishlistItemDto"},"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}},"paths":{"/api/wishlists":{"get":{"summary":"getWishlist","operationId":"getWishlistUsingGET","parameters":[{"name":"pageSize","in":"query","required":false,"description":"Determines the number of wishlist items returned in the API response. Default page size is 50 and max is 50.","schema":{"type":"string"}},{"$ref":"#/components/parameters/X-TWC-Tenant-2"},{"in":"query","name":"id","description":"TWC's unique identifier for a wishlist","schema":{"type":"string"}},{"in":"query","name":"ref","description":"The retailer's unique identifier for a wishlist.  Implementations typically use the TWC unique identifier rather than this parameter.","schema":{"type":"string"}},{"$ref":"#/components/parameters/lastItemId"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WishlistDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false,"description":"Retrieves the wishlist and the wishlist items that belongs to the given ***wishlistId*** or ***wishlistRef***. If the wishlist does not exist, this method returns a ResourceNotFound error.\n\nThe returned item array is paginated - 50 default (50 maximum). The API will respond with the item count in the page, and the itemID the for the last item (lastitemID) returned for that response, which should then be used for the subsequent API call to retrieve the next page.","tags":["wishlists"]}}}}
```