Skip to main content
GET
Get Notification Policies

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

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

Required range: 1 <= x <= 1000
offset
integer | null

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

Required range: x >= 0
cursor
string | null

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

id
string<uuid>
required

The unique identifier of the notification policy.

Example:

"ede786f3-33ae-4894-843d-af2025f1d5b0"

scope
enum<string>
required

The scope of the notification policy.

Available options:
portfolio,
group,
item
name
string
required

The name of the notification policy.

item_id
string<uuid> | null
required

The unique identifier of the portfolio item, if any.

group_id
string<uuid> | null
required

The unique identifier of the portfolio group, if any.

enabled
boolean
required

Whether the notification policy is enabled.

cadence
enum<string>
required

The notification cadence.

Available options:
daily,
weekly,
biweekly,
monthly,
quarterly,
biannually,
annually
url
string
required
read-only
group_url
string | null
required
item_url
string | null
required
last_run_at
string<date-time> | null

When the notification policy was last executed.

next_run_on
string<date-time> | null

When the notification policy will be executed next.

attributes
enum<string>[]

The attributes to notify on.

Available options:
registration_health,
new_registrations,
addresses,
officers,
alternative_names,
kyb_score,
risk_score,
identity_network,
pep,
ofac,
liens,
litigations,
bankruptcies,
website_analysis