BCP CRM icon

BCP CRM

Interact with BCP CRM API

Overview

The node interacts with the BCP CRM API to perform various operations on CRM resources such as Deals, Contacts, Companies, Leads, and Tickets. Specifically for the Deal resource with the Get By Filter operation, it retrieves a list of deals filtered by a specified filter ID. This is useful when you want to fetch deals that meet certain predefined criteria without manually specifying complex query parameters.

Practical examples include:

  • Retrieving all deals in a specific sales pipeline stage.
  • Fetching deals assigned to a particular sales representative.
  • Getting deals filtered by custom filters defined in the CRM system.

This operation simplifies data retrieval by leveraging saved filters from the CRM.

Properties

Name Meaning
Filter Name or ID Choose a predefined filter from the list or specify its ID via an expression. The filter determines which deals are retrieved based on saved criteria in the CRM.

Output

The output is a JSON array where each element represents a deal object matching the selected filter. Each deal object contains fields as defined by the CRM's deal schema, including identifiers, names, statuses, and other deal-specific data.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the BCP CRM API.
  • The node makes HTTP requests to the BCP CRM endpoints using the base URL and API key provided in the credentials.
  • The filter options are dynamically loaded from the CRM via an API call, so the node depends on the availability and correctness of these filters in the CRM system.

Troubleshooting

  • Common issues:

    • Using an invalid or expired API key will cause authentication failures.
    • Specifying a filter ID that does not exist or is not accessible will result in no data or errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Errors returned from the API (e.g., unauthorized, not found) will be thrown by the node.
    • If the filter parameter is missing or empty, the node may fail to retrieve data.
  • Resolutions:

    • Verify that the API key credential is valid and has necessary permissions.
    • Confirm the filter exists in the CRM and is correctly selected.
    • Check network connectivity and endpoint accessibility.
    • Use expressions carefully to ensure the filter ID resolves correctly.

Links and References

Discussion