List offer codes with the Gumroad API
Lists the offer codes of a product, with amount_cents for a fixed discount or percent_off for a percentage, uses, limit and validity. A universal code applies to every product.
- Identifier
- gumroad_list_offer_codes
The request
POST https://connect.reportei.com/api/tools/gumroad_list_offer_codes/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"product_id": "<product_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | Yes | Id of the product, from List products. |
Supported connections
Your customer connects their Gumroad account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/gumroad, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/gumroad_list_offer_codes. It becomes your agent's tool definition with no conversion.
Other Gumroad tools
- List productsGETLists the products of the account, newest first, 10 per page, in a short form: Get product returns the whole product. When more follow, the response has next_page_key, which goes in page_key.
- Get productGETReturns a product with price, description, category, tags, variants, files and, with the view_sales scope, sales_count and sales_usd_cents.
- List categoriesGETLists the product categories of Gumroad. The path of a category, such as design/ui-and-web/figma, goes in category in Create product and Update product.
- Create productPOSTCreates a product and publishes it right away, unless draft is true. When publishing is blocked, for example by an unconfirmed email or a missing payout method, the product stays a draft and the response has a warning: publish it later with Publish product.
- Update productPUTChanges a product and returns it. Only the fields sent change, but tags replaces the whole list. A warning in the response reports offer codes that stopped being valid for the product.
- Publish productPUTPublishes a draft or unpublished product, so buyers can buy it. Refused while the account has no confirmed email or no payout method, or when an offer code of the product leaves the price invalid.
- Unpublish productPUTUnpublishes a product, which stops new sales. Publish product puts it back on sale.
- List salesGETLists the successful sales of the account, newest first, 10 per page, with buyer email, product, price, refund, subscription and license data. When more follow, the response has next_page_key, which goes in page_key.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
