Hotmart icon

Hotmart

Consume the Hotmart API

Sale → Get Participants

AI-generated

Summary

Retrieve a list of participants involved in sales transactions, including producers, coproducers, and affiliates, filtered by optional criteria.

Inputs

  • Return All — Choose whether to return all matching participants or limit the number of results.
  • Limit — Set the maximum number of participant records to return when 'Return All' is false.
  • Filters — Apply filters such as 'End Date' (Unix timestamp in milliseconds), 'Product ID', 'Start Date' (Unix timestamp in milliseconds), and 'Transaction' code to narrow down the participants retrieved.

Output shape

a list of participant objects

Results are paginated from the API; this operation automatically handles fetching all pages when 'Return All' is true. Otherwise, results are limited to the specified 'Limit'. Each item in the output list represents a participant involved in sales and includes details as provided by the Hotmart API.

Links

Discussion