Perfex CRM icon

Perfex CRM

Consumir API do Perfex CRM
Join our community

Actions5

Overview

This node integrates with the Perfex CRM API to manage leads. Specifically, the "Pesquisar" (Search) operation under the "Lead" resource allows users to search for leads based on a search term. This is useful when you want to quickly find leads matching specific keywords or criteria without retrieving all leads.

Practical examples include:

  • Searching for leads by name, company, or other identifying information.
  • Filtering leads dynamically during workflow execution based on user input or external data.
  • Automating lead qualification processes by searching and then acting on matched leads.

Properties

Name Meaning
Termo de Pesquisa The search term used to find leads. This string is required and is used to query the leads in the CRM system.

Output

The output of the node is an array of JSON objects representing the leads that match the search term. Each item in the output corresponds to one lead returned by the API.

  • The json field contains the full response data from the Perfex CRM API for the searched leads.
  • There is no binary data output in this operation.

Example output structure (simplified):

[
  {
    "id": "123",
    "name": "John Doe",
    "email": "john@example.com",
    "company": "Example Corp",
    ...
  },
  {
    "id": "456",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "company": "Another Corp",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Perfex CRM API.
  • The node makes HTTP requests to the configured Perfex CRM instance URL.
  • The API key and base URL must be set up in the node credentials before use.

Troubleshooting

  • Common issues:

    • Invalid or missing API key: The node will fail to authenticate with the CRM API.
    • Incorrect base URL: If the URL is wrong or unreachable, the node will throw connection errors.
    • No leads found: If the search term does not match any leads, the output will be empty.

  • Error messages:

    • Authentication errors typically indicate invalid API keys or expired tokens.
    • Network errors suggest connectivity problems or incorrect URLs.
    • API errors may occur if the search term is malformed or the API endpoint changes.

  • Resolutions:

    • Verify the API key and ensure it has proper permissions.
    • Confirm the base URL points to a valid and accessible Perfex CRM instance.
    • Use valid and meaningful search terms to get results.

Links and References

Discussion