Actions39
- Catalog Operation Actions
- Common Operation Actions
- Contact Operation Actions
- HRMS Operation (India) Actions
- Purchase Operation Actions
- Sales Operation Actions
- Tax Operation (India) Actions
Contact Operation → Get All Contacts
AI-generatedOverview
This node operation retrieves a list of contacts from the LEDGERS API. It supports two search types: searching contacts by name or limiting the number of contacts returned per page. This operation is useful for scenarios where you need to fetch contact information either by specifying a search term (name) or by controlling the number of contacts retrieved in a single request (pagination). For example, you can use it to find specific contacts by name or to get a paginated list of contacts for further processing or display.
Use Case Examples
- Search contacts by name by providing a search term to filter results.
- Retrieve a limited number of contacts per page to manage large datasets efficiently.
Properties
| Name | Meaning |
|---|---|
| Search Type | Determines the method of searching contacts, either by name or by limit per page. |
| Search Term | The name string used to search contacts when 'Search by Name' is selected. |
| Limit (Per Page) | The maximum number of contacts to retrieve per page, applicable for both search types. |
Output
JSON
contacts- Array of contact objects retrieved from the API, containing contact details.
Dependencies
- Requires an API key credential for authenticating with the LEDGERS API.
Troubleshooting
- Authentication failures due to incorrect API credentials will prevent data retrieval. Ensure the API key and login credentials are correct.
- If no contacts are returned, verify the search term or limit parameters are set appropriately.
- Network or API endpoint issues may cause request failures; check connectivity and API status.
Links
- LEDGERS API Documentation - Official API documentation for understanding endpoints and parameters related to contacts.