Klipy
Actions13
Overview
This node interacts with the Klipy CRM API to manage "Person" resources, specifically supporting the "Get All" operation for persons. It retrieves multiple person records from the CRM system, optionally filtered and paginated by various query parameters such as email, phone number, company ID, owner, cursor, and limit.
Common scenarios where this node is beneficial include:
- Fetching a list of contacts for marketing campaigns.
- Retrieving all people associated with a specific company or owner.
- Paginating through large contact lists in a CRM for data synchronization or reporting.
For example, you can use this node to get up to 50 people who belong to a particular company or filter contacts by their email address.
Properties
| Name | Meaning |
|---|---|
| Cursor | Cursor string used for pagination to fetch the next set of results. |
| Limit | Maximum number of person records to return in one request (default is 20). |
| Filter results to only include persons with this email address. | |
| Phone | Filter results to only include persons with this phone number. |
| Company ID | Filter results to only include persons associated with this company ID. |
| Owner | Filter results to only include persons owned by this owner identifier. |
Output
The output is a JSON array containing person objects returned by the Klipy CRM API. Each object represents a person record with fields as defined by the API response (e.g., id, name, email, phone, company association, etc.).
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Klipy CRM API.
- The base URL for the Klipy API must be configured in the credentials.
- Uses HTTP requests (GET and POST) to interact with the API endpoints.
Troubleshooting
- Missing or invalid API key: The node will fail if the API key is missing or incorrect. Ensure the API key credential is properly set.
- Invalid base URL: If the base URL is not set or malformed, the node throws an error. Verify the base URL in the credentials.
- Invalid filter values: Providing invalid filter values (e.g., malformed email) may result in no data or API errors.
- Pagination issues: Using an incorrect cursor value may cause empty results or repeated data. Use the cursor provided by previous responses.
- API rate limits: Excessive requests may lead to rate limiting by the API; handle errors accordingly.
Links and References
- Klipy CRM API Documentation (Assumed link, replace with actual if available)
- n8n Documentation on HTTP Request Node for understanding API interactions.