Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with a Lead Management API to perform a "Lead Status Search" operation. It allows users to query lead statuses based on various criteria such as status, date, lead ID, and other optional filters. This is useful in scenarios where you want to retrieve leads that match specific status conditions for reporting, follow-up actions, or integration with other systems.
Practical examples include:
- Searching for all leads with a particular status on a given date.
- Filtering leads by list ID or archived status.
- Including custom fields in the search results for more detailed information.
Properties
| Name | Meaning |
|---|---|
| Function | The API function to call; fixed to "Lead Status Search" for this operation. |
| User | API user credential used for authentication. |
| Pass | API password credential used for authentication. |
| Source | Description of what originated the API call (default: "n8n"). |
| Status | Lead status to filter the search by (required). |
| Date | Date in YYYY-MM-DD format to filter the search (required). |
| Lead Id | Optional lead identifier to narrow down the search. |
| Custom Fields | Whether to include custom fields in the response; options are "Y" (yes) or "N" (no). |
| List Id | Optional list identifier to filter leads belonging to a specific list. |
| Archived Lead | Whether to include archived leads; options are "Y" (yes) or "N" (no). |
Output
The node outputs JSON data containing the results of the lead status search query. The structure typically includes details about each lead matching the search criteria, such as lead identifiers, status, dates, and optionally custom fields if requested.
If the API supports binary data output, it is not indicated here, so the output is expected to be purely JSON.
Dependencies
- Requires an API key credential consisting of a username and password for authenticating with the Lead Management API.
- The node uses HTTP requests to communicate with the external Lead Management service.
- Proper configuration of credentials and endpoint URLs within n8n is necessary.
Troubleshooting
- Authentication errors: Ensure that the provided API user and password are correct and have sufficient permissions.
- Invalid date format: The "Date" property must be in
YYYY-MM-DDformat; otherwise, the API may reject the request. - Missing required fields: The "Status" and "Date" properties are mandatory; omitting them will likely cause errors.
- Empty or no results: If no leads match the criteria, the output may be empty; verify the filter values.
- API connectivity issues: Check network access and endpoint URL correctness.
Links and References
- Refer to your Lead Management API documentation for detailed descriptions of the "lead_status_search" function and its parameters.
- n8n documentation on creating and using HTTP Request nodes for similar API integrations.