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

# List monitors



## OpenAPI

````yaml /api-reference/openapi.json get /render/monitors
openapi: 3.1.0
info:
  title: Scrinly Browser API
  version: 1.0.0
  description: >-
    Public screenshot, region, Visual Style Guide, visual diff, monitoring,
    batch, job-status, and usage API.
servers:
  - url: https://api.scrinly.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Screenshots
  - name: Batches
  - name: Diffs
  - name: Jobs
  - name: Usage
  - name: Monitors
  - name: Recipients
paths:
  /render/monitors:
    get:
      tags:
        - Monitors
      summary: List monitors
      operationId: listMonitors
      parameters:
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Cursor-paginated monitors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorList'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
  schemas:
    MonitorList:
      type: object
      required:
        - success
        - monitors
      properties:
        success:
          type: boolean
          const: true
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/Monitor'
        nextCursor:
          type:
            - string
            - 'null'
        total:
          type: integer
    Monitor:
      type: object
      required:
        - id
        - name
        - status
        - intervalMinutes
        - baselineMode
        - changeThreshold
        - capture
        - diff
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - paused
            - paused_plan_limit
            - deleted
        intervalMinutes:
          type: integer
        baselineMode:
          type: string
          enum:
            - rolling
            - fixed
        changeThreshold:
          type: number
        capture:
          type: object
          additionalProperties: true
        diff:
          $ref: '#/components/schemas/MonitorDiff'
        alerts:
          type: object
          additionalProperties: true
        baselineRunId:
          type:
            - string
            - 'null'
          format: uuid
        nextRunAt:
          type:
            - string
            - 'null'
          format: date-time
        lastRunAt:
          type:
            - string
            - 'null'
          format: date-time
        incident:
          type:
            - object
            - 'null'
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
        type:
          type: string
        code:
          type: string
        retryable:
          type: boolean
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
        credits:
          $ref: '#/components/schemas/Credits'
    MonitorDiff:
      type: object
      properties:
        mode:
          type: string
          enum:
            - pixel
            - perceptual
          default: perceptual
        visualization:
          type: string
          enum:
            - overlay
            - heatmap
            - mask
            - none
          default: overlay
      additionalProperties: false
    ErrorField:
      type: object
      required:
        - field
        - message
      properties:
        field:
          type: string
        message:
          type: string
    Credits:
      type: object
      required:
        - charged
        - refunded
        - net
      properties:
        charged:
          type: integer
          minimum: 0
        refunded:
          type: integer
          minimum: 0
        net:
          type: integer
          minimum: 0
  responses:
    Unauthorized:
      description: Invalid or missing Scrinly key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Scrinly API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.