Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Portfolio Monitoring

Get Portfolio Group Monitoring Policy

Get the monitoring policy for a portfolio group.

get/portfolio/groups/{group_id}/monitoring_policy

Path parameters

group_idstring uuid required

Response

Response

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

The cadence of monitoring.

attributesV1MonitorableAttributes[]

The attributes to monitor.

lien_monitoring_scope'domestic' | 'registered' required

The scope of states that will be monitored for liens.

When the scope is "domestic", the policy will monitor liens for the state of the domestic registration. When the scope is "registered", the policy will monitor liens for the states of all registrations.

enabledboolean required

Whether the monitoring policy is enabled.

last_run_atstring date-time nullable

When the notification policy was last executed.

next_run_onstring date nullable

When the notification policy is scheduled to run next.

inherited_from'portfolio' | 'group'