Overview

This node operation retrieves multiple customer records from the Square API. It supports fetching either all customers or a limited number based on user input. This is useful for scenarios where you need to list or process customer data in bulk, such as syncing customer lists, generating reports, or performing batch updates.

Use Case Examples

1. Fetch all customers to synchronize with a CRM system.
2. Retrieve a limited number of customers for display in a dashboard or report.

Properties

Output

JSON

• id - Unique identifier of the customer.
• given_name - Customer's given (first) name.
• family_name - Customer's family (last) name.
• email_address - Customer's email address.
• phone_number - Customer's phone number.
• created_at - Timestamp when the customer record was created.
• updated_at - Timestamp when the customer record was last updated.

Dependencies

• Square API
• An API key credential for Square API authentication

Troubleshooting

• If the node returns an error related to authentication, ensure the Square API credentials are correctly configured.
• If no customers are returned, verify that the Square account has customer data and the API permissions allow access.
• If the 'Limit' is set too low, fewer customers than expected will be returned; adjust the limit or set 'Return All' to true.
• Errors related to rate limits may occur if fetching all customers; consider using pagination or limiting the number of results.

Links

• Square Customers API - List Customers - Official Square API documentation for listing customers.