Kiwify icon

Kiwify

Interagir com a API da Kiwify

Actions19

Overview

This node integrates with the Kiwify API to perform various operations related to products, sales, affiliates, webhooks, payouts, and participants. Specifically, the "Listar Participantes" (List Participants) operation retrieves a paginated list of event participants filtered by multiple criteria such as product ID, check-in status, creation/update dates, external IDs, phone, CPF, and order ID.

This node is useful for automating workflows that require managing or analyzing participant data from Kiwify events, such as:

  • Exporting participant lists for event management.
  • Filtering participants who have checked in or meet specific criteria.
  • Integrating participant data into CRM or marketing tools.
  • Monitoring participant activity over time.

Practical Example

You want to get a list of participants for a specific product event who have already checked in, limiting results to 20 per page, and filtering by creation date range. This node can fetch that data directly from Kiwify's API, enabling you to automate follow-up communications or reporting.

Properties

Name Meaning
ID Do Produto The product ID for which to list participants (required).
Check-in Realizado Filter participants by whether they have checked in (true or false).
Tamanho Da Página Number of participants to return per page (pagination size).
Número Da Página Page number to retrieve (pagination index).
Data De Criação - Início Start date filter for participant creation date (format: YYYY-MM-DD).
Data De Criação - Fim End date filter for participant creation date (format: YYYY-MM-DD).
Data De Atualização - Início Start date filter for participant update date (format: YYYY-MM-DD).
Data De Atualização - Fim End date filter for participant update date (format: YYYY-MM-DD).
External ID Filter participants by their external ID.
Batch ID Filter participants by batch ID (lot identifier).
Telefone Filter participants by phone number.
CPF Filter participants by CPF (Brazilian individual taxpayer registry identification).
ID Do Pedido Filter participants by order ID.

Output

The node outputs a JSON array where each item corresponds to a participant matching the specified filters. The structure reflects the participant data returned by the Kiwify API endpoint for event participants, including fields such as participant details, check-in status, timestamps, and identifiers.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kiwify API.
  • The node uses OAuth token retrieval internally via client ID and client secret provided in credentials.
  • Requires network access to https://public-api.kiwify.com.
  • The user must configure the node with valid Kiwify API credentials and account ID.

Troubleshooting

  • Common Issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Incorrect product ID or filters may result in empty responses.
    • Pagination parameters out of range may return no data.
    • Date filters must be in YYYY-MM-DD format; invalid formats may cause errors.

  • Error Messages:

    • Authentication errors typically indicate issues with the API key or client credentials.
    • HTTP 404 errors may mean the product ID or resource does not exist.
    • Validation errors if required parameters like product ID are missing.

  • Resolutions:

    • Verify API credentials and ensure they have proper permissions.
    • Double-check all input parameters for correctness and completeness.
    • Use smaller page sizes or adjust page numbers if pagination returns no data.
    • Ensure date strings conform to the expected format.

Links and References

If you need summaries for other operations or resources, please provide their names.

Discussion