---
title: "List monitors"
method: GET
path: "/v1/monitors"
tags: ["monitors"]
---

# List monitors

`GET /v1/monitors`

## Request

- Base URL: `https://api.olostep.com`
- URL: `https://api.olostep.com/v1/monitors`
- Auth: HTTP bearer

Retrieve the monitors for the authenticated team.

## Query parameters

- `include_deleted` 'true' | 'false'

## Response `200`

Default Response

- object: A page of monitors.
  - `monitors` object[], required
    - `id` string, required
    - `object` string
    - `query` string, required
    - `tracked` object
      - `type` string, nullable
      - `urls` string[]
      - `web_query` string, nullable
    - `source_policy` object
      - `include_urls` string[]
      - `exclude_urls` string[]
      - `include_domains` string[]
      - `exclude_domains` string[]
    - `schedule` object
      - `frequency` string, nullable
      - `cron` string, nullable
      - `timezone` string
      - `next_run_at` string, nullable
    - `notification` object
      - `events` string[]
      - `channels` object[]
        - `type` 'email' | 'slack' | 'sms', required
        - `target` string, required
        - `events` string[]
    - `webhook` object, nullable
      - `url` string, uri, required
    - `output_schema` object, nullable
    - `status` 'provisioning' | 'active' | 'paused' | 'failed' | 'deleted', required
    - `error_message` string, nullable
    - `last_run` object, nullable
      - `id` string, nullable
      - `status` string
      - `change_detected` boolean, nullable
      - `ran_at` string, nullable
    - `last_change` object, nullable
      - `id` string, nullable
      - `ran_at` string, nullable
      - `changed` boolean, nullable
    - `agent` object
      - `id` string, nullable
    - `metadata` object
    - `created` number, required
    - `updated` number
    - `total_count` number
    - `mermaid_diagram` string
  - `count` number

## Other responses

- `401`: Default Response
- `502`: Default Response

---

[API](https://skmtc.dev/olostep/apis/olostep-api.md) · [All operations](https://skmtc.dev/olostep/apis/olostep-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olostep/apis/olostep-api/revisions/13c766ab100c?raw)