Get Opportunity
highlevel.get_opportunity
ActionCRM & salesconnection required
Calls the HighLevel API with the connection's credentials.
Read one opportunity by its id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- HighLevel
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for a marketplace app, or {"access_token": "…"} for a Private Integration Token
- Config it needs
- location_id, user_type, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
opportunity_id The opportunity id. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The opportunity id. | string | — |
name Opportunity name. | string | — |
monetaryValue Deal value. | number | — |
pipelineId The pipeline it sits in. | string | — |
pipelineStageId The stage it sits in. | string | — |
status open, won, lost or abandoned. | string | — |
contactId The contact it belongs to. | string | — |
locationId The sub-account it belongs to. | string | — |
assignedTo User id it is assigned to. | string | — |
createdAt When it was created (ISO-8601). | string | — |
updatedAt When it last changed (ISO-8601). | string | — |
{
"assignedTo": "",
"contactId": "",
"createdAt": "",
"id": "",
"locationId": "",
"monetaryValue": 0,
"name": "",
"pipelineId": "",
"pipelineStageId": "",
"status": "",
"updatedAt": ""
}See Get Opportunity run in a workflow.
In a technical demo we add the HighLevel connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.