Get opportunity - Automate.ax

highlevel.getOpportunity retrieves one opportunity by ID.

automations/highlevel-get-opportunity.automation.ts

import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Get opportunity", () => {
  markSignificant(
    highlevel.getOpportunity({
      id: "yWQobCRIhRguQtD2llvk",
    }),
  )
})

Input

Field	Type	Required	Description
`id`	`string`	Yes	HighLevel id value.

Automate.ax supplies the connected sub-account’s location ID. Optional second argument { account } selects a named HighLevel binding.

Output

Field	Type	Required	Description
`opportunity`	`object`	No	HighLevel opportunity value.

This action calls GET /opportunities/{id} with HighLevel API version 2021-07-28 and requires opportunities.readonly. HighLevel validation and permission errors fail the action. Rate limits honor the provider’s retry timing.