List Monitors

GET /v1/monitor

JavaScript

JavaScript

import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

const monitors = await client.monitor.list();

console.log(monitors.items);

200

{
  "items": [
    {
      "entity_id": "<string>",
      "preferences": [],
      "disabled": true
    }
  ]
}

List monitors

Returns all monitors created for the current API user.

Cost: 0 credits

Available for Business Plan and Enterprise customers. Request access to get started.

See the Monitoring guide for a full overview of how monitoring works, including webhook setup and preference options.

Response

The response contains an items array. Each item represents one active or disabled monitor and includes:

Field	Type	Description
entity_id	string	The company register ID or person UUID being monitored
entity_type	string	company or person
preferences	array	The data categories this monitor is watching
disabled	boolean	Whether the monitor has been disabled by the system

The disabled flag

A monitor is marked disabled: true when your account is downgraded to a plan that no longer includes monitoring access. Disabled monitors are preserved so you do not lose your configuration, but they stop delivering notifications.

Monitors are not automatically re-enabled when you upgrade again — this is intentional to prevent unexpected billing. To re-enable a disabled monitor, contact the team at [e-mail].

Use the list endpoint to check for disabled monitors after any plan change so you can act before missing notifications.

Use Cases

Audit active subscriptions — Retrieve the full list of entities you are currently watching to verify coverage, identify gaps, or reconcile against your internal records.

Detect disabled monitors — Filter the response for disabled: true items to find monitors that have stopped delivering notifications due to a plan downgrade. Contact [e-mail] to get them re-enabled.

Reconcile with your database — Periodically compare the list of monitors against your own data to identify entities that should no longer be monitored and clean them up with the delete endpoint.

Authorizations

Authorization · string · header · required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Response

200

application/json

Success

items · object[] · required

List of webhook monitor items.

Show child attributes