> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Monitors

> Retrieves all monitors for your team. Returns active monitors by default and can include deleted monitors when requested.



## OpenAPI

````yaml openapi/monitors.json GET /v1/monitors
openapi: 3.0.3
info:
  title: Monitors API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/monitors:
    get:
      summary: List Monitors
      description: >-
        Retrieves all monitors for your team. By default, deleted monitors are
        filtered out.
      parameters:
        - name: include_deleted
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
          description: Set to true to include deleted monitors.
      responses:
        '200':
          description: Successful response with list of monitors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  monitors:
                    type: array
                    items:
                      $ref: '#/components/schemas/Monitor'
                  count:
                    type: integer
              example:
                monitors:
                  - id: monitor_5hktz469jy
                    object: monitor
                    created_at: 1777983215
                    cron_expression: 13 13 * * ? *
                    fda_id: fda_5hktz469jy
                    frequency: daily
                    metadata: {}
                    notification_channel: email
                    notification_target: example@olostep.com
                    query: >-
                      Gather the new blogposts from example website and send me
                      updates with new posts.
                    status: active
                    team_id: team_5hktz469jyF
                    updated_at: 1777983222
                count: 1
        '401':
          description: Invalid API key.
        '500':
          description: Internal server error while listing monitors.
      security:
        - Authorization: []
components:
  schemas:
    Monitor:
      type: object
      properties:
        id:
          type: string
          description: Unique monitor identifier.
        object:
          type: string
          example: monitor
        team_id:
          type: string
        status:
          type: string
          description: >-
            Monitor lifecycle status. Common values: `active` (running on
            schedule), `paused` (schedule disabled via /pause, can be resumed
            via /resume), `deleted` (soft-deleted).
          enum:
            - active
            - paused
            - deleted
        fda_id:
          type: string
        query:
          type: string
          description: >-
            Monitoring intent in natural language. If the query includes a URL,
            the monitor will focus on that URL.
        frequency:
          type: string
          description: >-
            Natural-language schedule instruction (for example: 'every day at
            9am America/Los_Angeles' or 'every weekday at 14:30'). If no
            timezone is specified, UTC is used.
        cron_expression:
          type: string
          nullable: true
        notification_channel:
          type: string
          enum:
            - email
            - webhook
            - sms
        notification_target:
          type: string
        metadata:
          type: object
          additionalProperties: true
        output_schema:
          type: object
          description: >-
            Optional JSON schema used to enforce structured monitor extraction
            output.
          additionalProperties: true
          nullable: true
        error_message:
          type: string
          nullable: true
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form Bearer <token>, where <token>
        is your auth token.

````