List sales with the Gumroad API

Lists 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.

Identifier
gumroad_list_sales

The request

POST https://connect.reportei.com/api/tools/gumroad_list_sales/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "after": "<after>"
  }
}

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

ParameterTypeRequiredDescription
afterstringNoOnly sales after this date, YYYY-MM-DD.
beforestringNoOnly sales before this date, YYYY-MM-DD.
product_idstringNoId of a product from List products: only its sales.
emailstringNoEmail address of the buyer.
namestringNoName of the buyer.
order_idstringNoThe numeric order number shown on the receipt of the buyer.
license_keystringNoLicense key sold with the product.
page_keystringNoThe next_page_key of the previous response. Keep the same filters.

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_sales. It becomes your agent's tool definition with no conversion.

Other Gumroad tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.