HighLevel icon

HighLevel

Consume HighLevel API
Join our community

Actions16

Overview

The HighLevel n8n node, when configured with the "Opportunity" resource and the "Get All" operation, retrieves a list of opportunities from the HighLevel API. This is useful for automating workflows that need to access, filter, or process sales opportunities data—such as syncing opportunities to a CRM, generating reports, or triggering actions based on opportunity status.

Practical examples:

  • Fetching all open opportunities in a specific pipeline for reporting.
  • Filtering opportunities assigned to a particular user.
  • Retrieving opportunities within a certain date range or by campaign.

Properties

Name Type Meaning
Pipeline ID options Selects the pipeline from which to retrieve opportunities. Can be chosen from a list or specified via an expression.
Return All boolean If enabled, returns all matching opportunities; if disabled, limits results to the number specified in "Limit".
Limit number Maximum number of opportunities to return (only shown if "Return All" is false). Range: 1–100.
Filters collection Additional filters to narrow down results. Includes:
— Assigned To options Filter by the user assigned to the opportunity.
— Campaign ID string Filter by campaign identifier.
— End Date number Filter by end date (epoch timestamp, e.g., 1614091050459).
— Monetary Value number Filter by the monetary value of the opportunity.
— Stage ID options Filter by stage within the selected pipeline.
— Start Date number Filter by start date (epoch timestamp, e.g., 1598107050459).
— Status options Filter by opportunity status: Open, Won, Lost, or Abandoned.
— Query string Search term applied to Name, Phone, Email, Tags, and Company Name fields.

Output

The node outputs a JSON array where each item represents an opportunity retrieved from the HighLevel API. Each object typically contains fields such as:

{
  "id": "string",
  "name": "string",
  "pipelineId": "string",
  "stageId": "string",
  "status": "string",
  "assignedTo": "string",
  "monetaryValue": "number",
  "startDate": "number",
  "endDate": "number",
  // ...other opportunity-specific fields
}

Note: The exact structure depends on the HighLevel API's response.

Dependencies

  • External Service: Requires access to the HighLevel API.
  • API Credentials: You must configure the highLevelApi credential in n8n with your HighLevel API key.
  • n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Invalid or missing credentials: Ensure the highLevelApi credential is correctly set up in n8n.
  • Incorrect Pipeline/Stage IDs: If using expressions or manual entry, verify that IDs exist in your HighLevel account.
  • API Rate Limits: Excessive requests may trigger rate limiting by HighLevel.
  • Date Format Errors: Ensure epoch timestamps are used for date filters.

Common Error Messages:

  • "401 Unauthorized": Check your API key and permissions.
  • "400 Bad Request": Likely due to invalid filter values or parameters (e.g., wrong ID format).
  • "404 Not Found": The specified pipeline, stage, or campaign does not exist.

Links and References

Discussion