Polar icon

Polar

Consume Polar.sh API
Join our community

Actions13

Overview

This node interacts with the Polar.sh API to manage customers, specifically supporting the "Get Many" operation for the Customer resource. It retrieves multiple customer records from the Polar system, optionally filtered by criteria such as email, external ID, organization ID, or a general search query.

Common scenarios include:

  • Fetching a list of customers for reporting or analysis.
  • Synchronizing customer data between Polar and another system.
  • Retrieving customers matching specific filters to trigger further automation.

For example, you could use this node to get all customers belonging to a particular organization or to find customers by their email addresses.

Properties

Name Meaning
Return All Whether to return all matching customer records or limit the number of results returned.
Limit Maximum number of customer records to return if not returning all (minimum 1).
Filters Criteria to filter the customers:
- Email Filter customers by their email address.
- External ID Filter customers by an external identifier.
- Organization ID Filter customers by their associated organization ID.
- Query A general search query string to filter customers.

Output

The output is an array of JSON objects, each representing a customer record retrieved from the Polar API. Each object contains the full customer data as returned by the API, including fields like email, billing address, metadata, and other customer attributes.

If multiple customers are returned, each will be a separate item in the output array.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Polar.sh API.
  • The node uses the Polar.sh API endpoints, switching between sandbox and production URLs based on the configured environment.
  • No additional external dependencies beyond the Polar API and n8n's HTTP request capabilities.

Troubleshooting

  • Empty Results: If no customers are returned, verify that your filters are correct and that customers exist matching those criteria.
  • API Authentication Errors: Ensure the API key credential is valid and has appropriate permissions.
  • Rate Limits or Timeouts: When requesting all customers (Return All enabled), large datasets may cause timeouts or rate limiting. Consider using filters or limits to reduce data volume.
  • Invalid Filter Values: Passing invalid or malformed filter values may result in API errors. Double-check filter inputs.
  • Error Messages: Errors from the Polar API will be surfaced with messages and descriptions. Review these to adjust parameters or credentials accordingly.

Links and References

Discussion