Gumroad

Get Gumroad wishlist

Get a Gumroad wishlist with its owner and first items.

GET/v1/gumroad/wishlist
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
urlstringrequiredquery

Public wishlist URL, e.g. https://clifhuman.gumroad.com/wishlists/some-list.

Response fields
66

Endpoint-specific response payload.

datalookupStatus
string

Whether the item exists. `not_found` covers an unknown or deleted item (Gumroad does not tell those apart).

one of: found, not_found

The wishlist when found. Its first 20 items are here; page the rest with the wishlist items endpoint.

datawishlistid
string

Wishlist id.

datawishlistname
stringnullable

List name.

datawishlistdescription
stringnullable

List description.

datawishlisturl
stringnullable

Public wishlist URL.

The buyer who published the list.

datawishlistownername
stringnullable

Owner's display name.

datawishlistownerurl
stringnullable

Owner's storefront URL.

datawishlistowneravatarUrl
stringnullable

Owner's avatar URL.

The first items.

datawishlistitems[]id
string

Wishlist item id.

The product on the list.

datawishlistitems[]productid
stringnullable

Product id; null only on a landing-layout creator, whose products have no id.

datawishlistitems[]productpermalink
stringnullable

The product's permalink on this route. A product can carry a short id on one route and the seller's custom permalink on another; either form resolves when you also pass the creator. Null when the route does not send one.

datawishlistitems[]productname
string

Product name.

datawishlistitems[]producttype
stringnullable

`digital`, `ebook`, `course`, `membership`, `bundle`, `physical`, `call` or `commission`; unknown values pass through.

datawishlistitems[]producturl
stringnullable

Product URL, without tracking parameters.

datawishlistitems[]productthumbnailUrl
stringnullable

Thumbnail URL.

datawishlistitems[]productcoverUrl
stringnullable

Cover image URL; null when the row has none.

datawishlistitems[]productsummary
stringnullable

Short description as Gumroad's lists show it, cut at about 100 to 164 characters. On the product record `summary` is the seller's own summary field instead.

The creator; null only when Gumroad omits it.

datawishlistitems[]productcreatorid
stringnullable

Creator's external id.

datawishlistitems[]productcreatorusername
stringnullable

Storefront subdomain label, e.g. `clifhuman`.

datawishlistitems[]productcreatorname
stringnullable

Display name.

datawishlistitems[]productcreatorurl
stringnullable

Storefront URL.

datawishlistitems[]productcreatoravatarUrl
stringnullable

Avatar URL.

datawishlistitems[]productcreatorisVerified
booleannullable

Whether Gumroad verified the creator.

Rating summary; null on a landing-layout creator, which has none.

datawishlistitems[]productratingsaverage
numbernullable

Average rating, 1 to 5; null when there are no ratings.

datawishlistitems[]productratingscount
integer

Number of ratings.

≥ 0

The product's price in its own currency.

datawishlistitems[]productpriceamount
integernullable

Price in the product's own currency, in Gumroad's smallest unit for it: cents for most currencies, whole yen for JPY, and 1/100 for KRW and TWD. 0 means free.

≥ 0

datawishlistitems[]productpricecurrency
stringnullable

ISO 4217 code of the product's own currency, e.g. `usd`.

datawishlistitems[]productpriceformatted
stringnullable

Price as Gumroad displays it, e.g. `$0+` or `€150`. A trailing `+` means pay-what-you-want or tiers.

datawishlistitems[]productpriceoriginalAmount
integernullable

Price before a sale, in the same unit as `amount`; null when not on sale or on the product record, which does not carry it.

≥ 0

datawishlistitems[]productpricepayWhatYouWant
booleannullable

Whether the buyer may pay another amount.

datawishlistitems[]productpricesuggestedAmount
integernullable

Suggested amount in the same unit as `amount`; null when the product does not set one.

≥ 0

datawishlistitems[]productpricedefaultAmount
integernullable

Default pay-what-you-want amount in the same unit as `amount`; null when the product does not set one.

≥ 0

datawishlistitems[]productsaleLabel
stringnullable

Sale label, e.g. `Black Friday`; null when not on sale.

Stock state.

datawishlistitems[]productstockremaining
integernullable

Units left when the creator limits sales.

≥ 0

datawishlistitems[]productstockquantityEnabled
booleannullable

Whether the creator limits the quantity.

datawishlistitems[]productstockisLimited
booleannullable

Whether the creator marked the product as limited.

Subscription fields a search record carries.

datawishlistitems[]productsubscriptionrecurrence
stringnullable

Billing period, e.g. `monthly`.

datawishlistitems[]productsubscriptiondurationInMonths
integernullable

Membership duration in months.

≥ 0

datawishlistitems[]option
stringnullable

Chosen variant.

datawishlistitems[]recurrence
stringnullable

Chosen billing period.

datawishlistitems[]quantity
integernullable

Quantity.

≥ 0

datawishlistitems[]rent
booleannullable

Whether the item is a rental.

datawishlistitems[]addedAt
stringnullable

When the item was added.

datawishlistitems[]purchasable
booleannullable

Whether the item can be bought now.

datawishlistitems[]giftable
booleannullable

Whether the item can be gifted.

Pagination state for the current page.

datawishlistpagenumber
integernullable

Page number of this answer.

datawishlistpagetotalPages
integernullable

Total pages in the list; null when not published.

datawishlistpagetotalItems
integernullable

Rows in the whole list; null when not published.

≥ 0

datawishlistpagehasMore
boolean

Whether more rows are available. When `nextCursor` is null, `moreVia` names the route that pages the rest.

datawishlistpagenextCursor
stringnullable

Cursor for the next page on this route; null on the last page.

datawishlistpagemoreVia
stringnullable

When this response cannot page, the operation id that pages the rest, e.g. `gumroad.wishlist.items.list`; null when `nextCursor` pages this list.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/gumroad/wishlist?url=https://aliceman666.gumroad.com/wishlists/1-588657779" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Gumroad wishlist.