Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Portfolio Monitoring

Get Notification Policies

Get all notification policies in the organization with pagination. Policies are sorted by created_at in ascending order.

get/notification_policies

Query parameters

limitinteger

Maximum number of records to return in a single page. Must be between 1 and 1000.

Maximum number of records to return in a single page. Must be between 1 and 1000.

offsetinteger nullable

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

cursorstring nullable

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Response

Response

idstring uuid required

The unique identifier of the notification policy.

scope'portfolio' | 'group' | 'item' required

The scope of a portfolio monitoring policy.

namestring required

The name of the notification policy.

item_idstring uuid nullable required

The unique identifier of the portfolio item, if any.

group_idstring uuid nullable required

The unique identifier of the portfolio group, if any.

enabledboolean required

Whether the notification policy is enabled.

cadence'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'biannually' | 'annually' required

The cadence of monitoring.

last_run_atstring date-time nullable

When the notification policy was last executed.

next_run_onstring date-time nullable

When the notification policy will be executed next.

attributesV1NotifiableAttributes[]

The attributes to notify on.

urlstring required
group_urlstring nullable required
item_urlstring nullable required

Example response

[
  {
    "id": "ede786f3-33ae-4894-843d-af2025f1d5b0"
  }
]