Documentation Index
Fetch the complete documentation index at: https://mintlify.com/antiwork/gumroad/llms.txt
Use this file to discover all available pages before exploring further.
Endpoint
GET https://api.gumroad.com/v2/products/:id
Authentication
Requires OAuth scope: view_public or any public scope
Path Parameters
The product’s external ID or unique permalink
Response
Whether the request was successful
The product object
The product’s unique external ID
The product description in HTML format
The custom URL path (if set)
The currency code (e.g., “usd”)
URL to the product thumbnail image
Array of tag names associated with the product
Human-readable formatted price
Whether the product is published and available for purchase
Whether the product has been deleted
Whether the product has a “pay what you want” price
For recurring products: “monthly”, “yearly”, “quarterly”, “biannually”, or “every_two_years”
Whether the product requires shipping information
URL to preview the product
Maximum number of purchases allowed (null if unlimited)
Information about attached files (only if single file)
Custom fields to collect at checkout
Whether this is a tiered membership product
Available billing recurrences for tiered memberships
Product variants with pricing and options
Array of variant options
Price difference in cents from base price
Whether this variant has customizable pricing
Recurrence prices for tiered memberships
purchasing_power_parity_prices
Adjusted prices by country code for purchasing power parity
Number of successful sales (requires view_sales scope)
Total sales in USD cents (requires view_sales scope)
Example Request
curl -X GET "https://api.gumroad.com/v2/products/kUxDaJMg5NP9PpHRCNYCrw==" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response
{
"success": true,
"product": {
"id": "kUxDaJMg5NP9PpHRCNYCrw==",
"name": "My Awesome Product",
"description": "<p>This is an amazing product that will change your life.</p>",
"custom_permalink": "awesome-product",
"price": 2999,
"currency": "usd",
"short_url": "https://example.gumroad.com/l/awesome-product",
"thumbnail_url": "https://public-files.gumroad.com/variants/abc123/thumbnail.png",
"tags": ["digital", "course"],
"formatted_price": "$29.99",
"published": true,
"deleted": false,
"customizable_price": false,
"require_shipping": false,
"preview_url": null,
"custom_receipt": "Thank you for your purchase!",
"custom_summary": "A comprehensive course",
"subscription_duration": null,
"max_purchase_count": null,
"file_info": {},
"custom_fields": [],
"is_tiered_membership": false,
"recurrences": null,
"variants": [
{
"title": "License Type",
"options": [
{
"name": "Personal",
"price_difference": 0,
"is_pay_what_you_want": false,
"recurrence_prices": null
},
{
"name": "Commercial",
"price_difference": 5000,
"is_pay_what_you_want": false,
"recurrence_prices": null
}
]
}
],
"purchasing_power_parity_prices": {
"IN": 500,
"BR": 800,
"MX": 900
},
"sales_count": 42,
"sales_usd_cents": 125958
}
}
Error Responses
false when the request fails
Product Not Found
{
"success": false,
"message": "The product was not found."
}
Unauthorized
{
"success": false,
"message": "Unauthorized"
}
You can use either the product’s external ID or its unique/custom permalink to retrieve a product.