LEDGERS icon

LEDGERS

Interact with LEDGERS API

Overview

This node interacts with the LEDGERS API to retrieve contact information, specifically supporting an operation to get all contacts. It allows users to either search contacts by name or fetch a limited number of contacts per page. This functionality is useful in scenarios where you need to integrate contact data from the LEDGERS system into your workflows, such as syncing contacts, generating reports, or automating communication processes.

Practical examples:

  • Fetching a list of contacts matching a specific name for targeted marketing campaigns.
  • Retrieving a paginated list of contacts to process them in batches for data synchronization.

Properties

Name Meaning
Search Type Choose how to search contacts: "Search by Name" or "Search by Limit".
Search Term The name string to search for when "Search by Name" is selected.
Limit (Per Page) Number specifying how many contacts to retrieve per page when searching by limit or name.

Output

The node outputs JSON data containing the retrieved contacts from the LEDGERS API. Each item in the output corresponds to a contact record with its associated fields as returned by the API. The exact structure depends on the API response but typically includes contact details such as name, ID, and other relevant attributes.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential and user authentication credentials (email and password) for the LEDGERS API.
  • The node performs HTTP requests to the LEDGERS API endpoints, including login and contact retrieval.
  • Proper configuration of these credentials in n8n is necessary for successful execution.

Troubleshooting

  • Authentication Failures: If the node fails to authenticate, ensure that the provided email, password, and API key are correct and have sufficient permissions.
  • Empty or Unexpected Data: If no contacts are returned, verify the search parameters and confirm that the LEDGERS account contains matching contacts.
  • API Errors: Network issues or API downtime can cause request failures; check connectivity and API status.
  • Limit Parameter: Setting an excessively high limit may lead to performance issues or API rate limiting.

Links and References

Discussion