Skip to main content
GET
List Watched Opportunities

Authorizations

api_key
string
header
required

Query Parameters

policyOId
string

Restrict to opportunities enrolled under this Opportunity Watch policy.

state
enum<string>

Restrict to enrollments in this state.

Available options:
auto_included,
pinned,
excluded
stageCategory
enum<string>

Restrict to opportunities in this CRM stage category.

Available options:
open,
closed_won,
closed_lost,
other
dealType
string

Restrict to opportunities with this CRM deal-type picklist value (Salesforce Type, HubSpot dealtype), matched exactly.

Case-insensitive substring match against the opportunity name.

limit
integer
default:25

Page size (default: 25, max: 100).

Required range: 1 <= x <= 100
Example:

25

offset
integer | null
default:0

Pagination offset (default: 0).

Required range: x >= 0
Example:

0

Response

Page of watched opportunities

_metadata
object
required
data
object[]
required
total
number
required
hasNext
boolean
required