Actions26
Overview
The node integrates with the GoHighLevel V2 API to retrieve multiple Opportunity records based on specified filters and pagination options. It is useful for workflows that need to fetch a list of sales opportunities, for example, to analyze pipeline stages, track statuses, or synchronize opportunity data with other systems.
Typical use cases include:
- Extracting all open or won opportunities for reporting.
- Filtering opportunities by assigned user, campaign, or date range.
- Including related calendar events, notes, or tasks linked to each opportunity.
- Paginating through large sets of opportunities or retrieving all at once.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of opportunity results to return (minimum 1). |
| Return All | Whether to return all matching opportunities or limit the results to the specified "Limit". |
| Filters | Collection of optional filters to narrow down the opportunities: |
| - Assigned To | Filter by assigned user ID. |
| - Campaign ID | Filter by campaign ID. |
| - Contact ID | Filter by contact ID associated with the opportunity. |
| - Country | Filter by country. |
| - End Date | Filter opportunities ending on or before this date (format: mm-dd-yyyy). |
| - Include Calendar Events | Whether to include calendar events related to the opportunity's contact. |
| - Include Notes | Whether to include notes related to the opportunity's contact. |
| - Include Tasks | Whether to include tasks related to the opportunity's contact. |
| - Limit | Max number of results to return (within filters collection; may override main Limit). |
| - Page | Page number for paginated results (default 1). |
| - Pipeline ID | Filter by pipeline ID. |
| - Pipeline Stage ID | Filter by pipeline stage ID. |
| - Search Query | Text search term to filter opportunities (e.g., email, name). |
| - Start Date | Filter opportunities starting on or after this date (format: mm-dd-yyyy). |
| - Status | Filter by opportunity status. Options: Abandoned, All, Lost, Open, Won. Default is All. |
Output
The node outputs an array of JSON objects, each representing an opportunity record retrieved from GoHighLevel. Each object contains the opportunity's fields as returned by the API, including any requested related data such as calendar events, notes, or tasks if those options are enabled.
If binary data were involved (not indicated here), it would be included in the binary output field, but this node focuses on JSON data only.
Dependencies
- Requires an active connection to the GoHighLevel V2 API via OAuth2 authentication.
- The node depends on the GoHighLevel API version "2021-07-28".
- No additional external services beyond GoHighLevel are required.
- Proper API credentials must be configured in n8n for authentication.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using invalid filter values (e.g., wrong date format) may result in API errors or empty results.
- Requesting too many records without enabling "Return All" may truncate results unexpectedly.
- Pagination parameters must be used carefully to avoid skipping or duplicating records.
Error messages:
"The resource \"opportunity\" is not known!": This indicates an internal misconfiguration or unsupported resource selection.- API errors related to rate limits or invalid parameters will be passed through; ensure filters conform to API expectations.
Resolutions:
- Verify API credentials and permissions.
- Use correct date formats (
mm-dd-yyyy) for date filters. - Enable "Return All" if you want to fetch all matching opportunities.
- Adjust pagination parameters to navigate through large datasets.