Developer API

WatchPage API documentation

Use a WatchPage API key to read alert history, event history, and monitor data from your workspace.

Create API key View endpoints

Auth

Bearer token

Send your API key in the Authorization header.

Format

JSON

All API endpoints return JSON responses.

Access

Team+

API access follows your workspace plan and key scopes.

Quick start

Create a key in Dashboard → Integrations, copy it once, then call the API with this header.

Authorization: Bearer pp_live_your_api_key

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/alerts?limit=25"

Endpoints

Available API endpoints

GET/api/v1/me

Verify that a key works and see the workspace it belongs to.

Any valid API key

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/me"

GET/api/v1/alerts?limit=25

Read the latest change alerts for your workspace.

alerts:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/alerts?limit=25"

GET/api/v1/alerts/{id}

Read one alert with monitor context and snapshot references.

alerts:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/alerts/alert_id"

GET/api/v1/events?limit=25

Read monitor event history. Filter by since, monitor_id, or event_type.

events:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/events?limit=25&since=2026-06-01T00:00:00Z"

GET/api/v1/events/{id}

Read one event with monitor context.

events:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/events/event_id"

GET/api/v1/monitors?limit=50

List active monitors in your workspace. Filter by status if needed.

monitors:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/monitors?limit=50&status=active"

GET/api/v1/monitors/{id}

Read one monitor and its latest events.

monitors:read

curl -sS -H "Authorization: Bearer pp_live_your_api_key" \
  -H "Accept: application/json" \
  "https://watchpage.app/api/v1/monitors/monitor_id"

Query parameters

limit — Number of items to return. Minimum 1, maximum 200.

since — ISO date filter for alerts and events.

monitor_id — Filter event history by one monitor.

event_type — Filter event history by event type.

status — Filter monitors by status, such as active, paused, or error.

API key scopes

alerts:read — Read alert records.

events:read — Read monitor event history.

monitors:read — Read monitor configuration and status.

* — Full read access for the current public API.

Common errors

Code	Meaning	What to do
401	Missing or invalid key	Create an API key in Dashboard → Integrations and send it as a Bearer token.
403	Missing scope or plan access	The key does not include the required scope, or the workspace plan does not include API access.
404	Not found	The requested item does not exist in the workspace linked to the API key.
429	Rate limited	Slow down requests and retry after a short delay.
500	Server error	Retry later. If it continues, contact WatchPage support.