Sharpei

Overview

The node integrates with the Sharpei API to list customer data. It is designed to fetch customer records from the Sharpei platform, which can be useful for workflows that require customer information retrieval, such as syncing customer lists, generating reports, or triggering actions based on customer data.

A practical example would be automating a marketing campaign by retrieving all customers and then filtering or segmenting them based on specific criteria in subsequent workflow steps.

Properties

Output

The node outputs JSON data containing the list of customers retrieved from the Sharpei API. Each item in the output corresponds to a customer record with fields as defined by the Sharpei API's customer schema.

If the "Return All" property is set to false, the output will contain up to the specified "Limit" number of customer records. If true, it returns all available customer records.

There is no indication that this node outputs binary data.

Dependencies

• Requires an API key credential for authenticating with the Sharpei API.
• The base URL for API requests is https://api.prod.gosharpei.com/api.
• The node expects the API to respond with JSON-formatted data.

Troubleshooting

• Common Issue: Not receiving any customer data.

  • Cause: Possibly due to incorrect API credentials or insufficient permissions.
  • Resolution: Verify that the API key credential is correctly configured and has access rights to read customer data.

• Common Issue: Receiving fewer results than expected.

  • Cause: The "Return All" property might be set to false with a low "Limit".
  • Resolution: Set "Return All" to true to retrieve all customers or increase the "Limit" value.

• Error Messages:

  • Authentication errors typically indicate invalid or missing API credentials.
  • Network or timeout errors suggest connectivity issues with the Sharpei API endpoint.

Links and References

• Sharpei API Documentation (Assumed official docs for further details on customer data structure and API usage)