Skip to main content
Retrieve details for a specific wishlist, including all items in the wishlist.

​
Authentication

This endpoint requires authentication for private wishlists. Public and shared wishlists can be accessed through their respective URLs.

​
Path Parameters

​
id
integer
required
The unique identifier of the wishlist

​
Accessing Shared and Public Wishlists

Depending on the wishlist’s audience setting, different access methods are available:
Endpoint: GET /api/v1/wishlists/{id}/Private wishlists can only be accessed by the owner with authentication.
curl --request GET \
  --url 'https://api.example.com/api/v1/wishlists/1/' \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Response

​
id
integer
Unique identifier for the wishlist
​
name
string
Name of the wishlist
​
owner
string
Display name of the wishlist owner
​
audience
string
Visibility setting for the wishlist
  • private: Only the owner can view the wishlist
  • public: Anyone can view the wishlist
  • shared: Only users with the sharing URL can view the wishlist
​
note
string
Optional notes about the wishlist
​
items
array
Array of products in the wishlist
​
absolute_url
string
Direct URL to access this wishlist
​
public_url
string
Public URL for the wishlist (only available if audience is public)
​
sharing_url
string
Shareable URL with token for the wishlist (only available if audience is shared)
​
created
string
Timestamp when the wishlist was created
​
updated
string
Timestamp when the wishlist was last updated

​
Example Response

200 - Success
{
  "id": 1,
  "name": "Birthday Wishlist",
  "owner": "[email protected]",
  "audience": "shared",
  "note": "Items I'd like for my birthday",
  "items": [
    {
      "id": 10,
      "product": {
        "id": 123,
        "name": "Wireless Headphones",
        "description": "Premium noise-cancelling headphones",
        "price": "79.99",
        "image_url": "https://example.com/images/headphones.jpg",
        "in_stock": true
      },
      "added_at": "2026-02-15T10:30:00Z"
    },
    {
      "id": 11,
      "product": {
        "id": 456,
        "name": "Smart Watch",
        "description": "Fitness tracking smartwatch",
        "price": "249.99",
        "image_url": "https://example.com/images/watch.jpg",
        "in_stock": true
      },
      "added_at": "2026-02-18T14:22:00Z"
    }
  ],
  "absolute_url": "/api/v1/wishlists/1/",
  "public_url": null,
  "sharing_url": "/api/v1/wishlists/shared/abc123def456/",
  "created": "2026-02-15T10:25:00Z",
  "updated": "2026-02-18T14:22:00Z"
}
401 - Unauthorized
{
  "detail": "Authentication credentials were not provided."
}
403 - Forbidden
{
  "detail": "You do not have permission to perform this action."
}
404 - Not Found
{
  "detail": "Not found."
}

​
Sharing Features

To share a private wishlist, update its audience to shared using the Update Wishlist endpoint. A unique sharing token will be automatically generated.The response will include a sharing_url that can be shared with others. Recipients can view the wishlist without authentication using this URL.
Set the audience to public to make a wishlist visible to anyone. Public wishlists can be accessed via the public_url endpoint without authentication.This is useful for gift registries, wedding wishlists, or public collections.
Change the audience back to private at any time. This will invalidate the sharing URL and make the wishlist visible only to the owner.
When a wishlist is set to shared or public, anyone with the URL can view all items in the wishlist. Ensure you only share wishlists that you’re comfortable making visible to others.

Build docs developers (and LLMs) love

Get started for freeTalk to us