Skip to main content
Retrieve all wishlists for the authenticated user. You can optionally filter wishlists by searching for specific names or products.

​
Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header.

​
Query Parameters

​
search
string
Search wishlists by name or product name. This performs a partial match across wishlist names and product names within the wishlists.

​
Response

Returns an array of wishlist objects. Each wishlist includes:
​
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. Options: private, public, or shared
  • 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 wishlist items
​
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 Request

cURL
curl --request GET \
  --url 'https://api.example.com/api/v1/wishlists/' \
  --header 'Authorization: Bearer YOUR_TOKEN'
Search Wishlists
curl --request GET \
  --url 'https://api.example.com/api/v1/wishlists/?search=birthday' \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
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",
          "price": "79.99",
          "image_url": "https://example.com/images/headphones.jpg"
        },
        "added_at": "2026-02-15T10:30:00Z"
      },
      {
        "id": 11,
        "product": {
          "id": 456,
          "name": "Smart Watch",
          "price": "249.99",
          "image_url": "https://example.com/images/watch.jpg"
        },
        "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"
  },
  {
    "id": 2,
    "name": "Holiday Shopping",
    "owner": "[email protected]",
    "audience": "private",
    "note": null,
    "items": [],
    "absolute_url": "/api/v1/wishlists/2/",
    "public_url": null,
    "sharing_url": null,
    "created": "2026-03-01T08:15:00Z",
    "updated": "2026-03-01T08:15:00Z"
  }
]
401 - Unauthorized
{
  "detail": "Authentication credentials were not provided."
}
The sharing_url is automatically generated when a wishlist’s audience is set to shared. Use this URL to share the wishlist with others without requiring authentication.

Build docs developers (and LLMs) love

Get started for freeTalk to us