getOpportunities

Query

aggregateMetrics

Aggregate all matching records in the database, ignoring pagination. At most 10 metrics; omit for normal records.

workspaceId

specificIds

first = 50

last

before

after

searchParams

sortField = "modifiedAt"

sortOrder = -1

accountId

accountIds

ownerId

ownerIds

excludeOwnerIds

Exclude opportunities owned by these users.

ownerIdIsNull

includeUnownedRecords

Include unassigned opportunities alongside selected owners.

pipelineIds

excludeStageIds

Exclude opportunities in these stages. Matches the stage id, or the stage key on records without one.

stageIds

stageKeys

stageState

excludeStageStates

Exclude opportunities in these open/closed states.

isWon

isLost

Only deals whose stage outcome is explicitly lost (true), or every other deal (false). Dormant and other no-outcome closed deals are not lost; isWon: false still includes them.

forecastCategories

excludeForecastCategories

Exclude opportunities in these forecast categories.

types

excludeTypes

typeIds

Business type option ids from the workspace's business type setting (settings.crmFieldOptions.opportunityType).

excludeTypeIds

Exclude opportunities with these business type option ids.

minAmount

maxAmount

closeDateAfter

closeDateBefore

selector