Skip to main content
GET
List Watches

Overview

Returns the calling org’s watches with opaque cursor pagination. Requires the portfolios:manage scope.

Query Parameters

integer
default:"20"
Page size (1-100).
string
Opaque cursor returned in the previous response.
string
Filter by status: active or paused. There’s a third status, disabled, that a watch moves to when it’s deleted; disabled watches never appear in this list, so disabled isn’t a valid filter value here.

Response

string
Always "list".
object[]
Array of Watch summaries (see Create Watch for the shape).
alert_count_24h is always null on list responses; use Retrieve Watch for the per-watch count.
boolean
True when more pages exist.
object
string
Request identifier.

Errors

Code Examples