Actions47
- Card Actions
- Create
- Get
- Get All
- Update
- Delete
- Get Balance
- Add Points
- Deduct Points
- Add Amount
- Deduct Amount
- Add Stamps
- Deduct Stamps
- Transfer Points
- Transfer Amount
- Block Card
- Unblock Card
- Generate QR Code
- Get Operations
- Add Visits
- Deduct Visits
- Add Reward
- Deduct Reward
- Receive Reward
- Redeem Coupon
- Set Expiration Date
- Set Membership Tier
- Customer Actions
- Company Actions
- Template Actions
- Communication Actions
- Analytics Actions
- System Actions
Customer → Get All
AI-generatedOverview
The node interacts with a Digital Wallet Cards loyalty program API, specifically focusing here on the Customer resource with the Get All operation. It retrieves a list of customers from the system, supporting filtering, sorting, pagination, and limiting the number of results returned.
This node is beneficial in scenarios where you need to:
- Fetch all customers or a subset based on specific criteria.
- Integrate customer data into workflows for marketing, analytics, or CRM synchronization.
- Automate customer data retrieval with filters such as email, phone, or creation date ranges.
Practical example:
You want to retrieve all customers created after a certain date who have a specific email domain, sorted by their last name in ascending order, and process this list further in your workflow.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching customers or limit the number of results. |
| Limit | Maximum number of customers to return (used only if Return All is false). |
| Additional Fields | Optional filters and parameters: |
| - Page | Page number for pagination (starting at 1). |
| - Sort By | Field name to sort the results by (e.g., "lastName", "createdAt"). |
| - Sort Order | Sort direction: Ascending or Descending. |
| - Filter by Email | Filter customers by their email address (partial or full match). |
| - Filter by Phone | Filter customers by their phone number. |
| - Created After | Filter customers created after this date/time. |
| - Created Before | Filter customers created before this date/time. |
Output
The output is an array of JSON objects representing customers. Each object contains customer details as returned by the API, such as:
- Customer ID
- First name
- Last name
- Phone
- Gender
- Date of birth
- External user ID
- Metadata (additional custom data)
The exact fields depend on the API response but generally include all relevant customer information.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests to the Digital Wallet Cards API.
- The node uses HTTP methods (GET) to interact with the
/api/v2/customersendpoint. - Supports paginated API requests internally to handle large result sets when "Return All" is enabled.
Troubleshooting
Common issues:
- Providing invalid filter values (e.g., incorrect date format) may cause API errors.
- Exceeding API rate limits could result in request failures.
- Not setting up the required API authentication properly will lead to authorization errors.
Error messages:
"Either phone or email must be provided for customer creation"— not applicable here but indicates required fields in other operations."Unknown customer operation: <operation>"— occurs if an unsupported operation is selected.- Network or API errors will typically propagate; ensure connectivity and valid credentials.
Resolution tips:
- Validate input parameters carefully.
- Check API credentials and permissions.
- Use "Return All" cautiously to avoid very large data loads that might impact performance.
Links and References
- Digital Wallet Cards API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes
- General REST API best practices for pagination and filtering.
If you need summaries for other resources or operations, feel free to ask!