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

# List Monitors

`GET /v0/monitors`

Lists all monitors for the Webset.

## Query parameters

- `cursor` string
- `limit` integer
- `websetId` string

## Response `200`

List of monitors

- ListMonitorsResponse
  - `data` Monitor[], required — The list of monitors
    - `id` string, required — The unique identifier for the Monitor
    - `object` 'monitor', required — The type of object
    - `status` 'enabled' | 'disabled', required — The status of the Monitor
    - `websetId` string, required — The id of the Webset the Monitor belongs to
    - `cadence` object, required — How often the monitor will run
      - `cron` string, required — Cron expression for monitor cadence (must be a valid Unix cron with 5 fields). The schedule must trigger at most once per day.
      - `timezone` string — IANA timezone (e.g., "America/New_York")
    - `behavior` object, required — Behavior to perform when monitor runs
      - `type` 'search', required
      - `config` object, required — Specify the search parameters for the Monitor. By default, the search parameters (query, entity and criteria) from the last search are used when no parameters are provided.
        - `query` string — The query to search for. By default, the query from the last search is used.
        - `criteria` object[] — The criteria to search for. By default, the criteria from the last search is used.
          - `description` string, required
        - `entity` union
          - CompanyEntity
            - `type` 'company', required
          - PersonEntity
            - `type` 'person', required
          - ArticleEntity
            - `type` 'article', required
          - ResearchPaperEntity
            - `type` 'research_paper', required
          - CustomEntity
            - `type` 'custom', required
            - `description` string, required
        - `count` number, required — The maximum number of results to find
        - `behavior` 'override' | 'append' — The behaviour of the Search when it is added to a Webset.
    - `lastRun` MonitorRun, required
      - `id` string, required — The unique identifier for the Monitor Run
      - `object` 'monitor_run', required — The type of object
      - `status` 'created' | 'running' | 'completed' | 'canceled' | 'failed', required — The status of the Monitor Run
      - `monitorId` string, required — The monitor that the run is associated with
      - `type` 'search' | 'refresh', required — The type of the Monitor Run
      - `completedAt` string, date-time, nullable, required — When the run completed
      - `failedAt` string, date-time, nullable, required — When the run failed
      - `failedReason` string, nullable, required — The reason the run failed
      - `canceledAt` string, date-time, nullable, required — When the run was canceled
      - `createdAt` string, date-time, required — When the run was created
      - `updatedAt` string, date-time, required — When the run was last updated
    - `nextRunAt` string, date-time, nullable, required — Date and time when the next run will occur in
    - `metadata` object, required — Set of key-value pairs you want to associate with this object.
    - `createdAt` string, date-time, required — When the monitor was created
    - `updatedAt` string, date-time, required — When the monitor was last updated
  - `hasMore` boolean, required — Whether there are more results to paginate through
  - `nextCursor` string, nullable, required — The cursor to paginate through the next set of results

---

[API](https://skmtc.net/exa/apis/exa-public-api.md) · [All operations](https://skmtc.net/exa/apis/exa-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/exa/exa-public-api/revisions/5c7114e0ef43/schema)