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

# Get Monitor List

> Retrieve a list of all monitors in the workspace.



## OpenAPI

````yaml en-openapi POST /monitors
openapi: 3.0.0
info:
  description: >-
    The Pubrio API is used to search, preview and enrich Contacts and Accounts.
    Pubrio database provides extensive B2B contacts and sales intelligence data.
  version: 1.0.0
  title: Pubrio OpenAPI
  termsOfService: https://pubrio.com/en/terms-of-service
  contact:
    email: king.lai@pubrio.com
    name: King Lai
    url: https://pubrio.com/en/get-in-touch
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.pubrio.com
security:
  - pubrio_api_key: []
tags:
  - name: Profile
    description: Workspace profile information and usage statistics
  - name: Enrichment
    description: Enrich people and company records with detailed B2B data
  - name: Lookalike
    description: Find companies similar to a given company
  - name: Search
    description: Search for people, companies, jobs, news, and advertisements with filters
  - name: Lookup
    description: >-
      Look up detailed information for specific people, companies, jobs, news,
      advertisements, and technologies
  - name: LinkedIn
    description: Look up people and company data via LinkedIn profile URLs
  - name: Redeem
    description: Redeem credits to unlock people contact details (single and batch)
  - name: Channels
    description: Manage outreach channel templates (create, update, delete, list)
  - name: Monitor
    description: Create and manage data monitors with webhooks, statistics, and processing
  - name: Filters
    description: >-
      Retrieve available filter values for search parameters (technologies,
      locations, verticals, etc.)
externalDocs:
  description: >-
    The Pubrio API is used to search, preview and enrich Contacts and Accounts.
    Pubrio database provides extensive B2B contacts and sales intelligence data.
  url: https://docs.pubrio.com
paths:
  /monitors:
    post:
      tags:
        - Monitor
      summary: List monitors
      description: Retrieve a list of all monitors in the workspace.
      operationId: monitors_list
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                destination_type:
                  type: array
                  items:
                    type: string
                  description: >-
                    Filter by destination types (e.g., ['email', 'webhook']).
                    Empty array returns all.
                detection_mode:
                  type: array
                  items:
                    type: string
                  description: >-
                    Filter by detection modes (e.g., ['company_first',
                    'signal_first']). Empty array returns all.
                is_active:
                  type: boolean
                  description: Filter by active status.
                is_paused:
                  type: boolean
                  description: Filter by paused status.
                is_ascending_order:
                  type: boolean
                  description: Sort in ascending order. Defaults to false (descending).
                  default: false
                order_by:
                  type: string
                  description: >-
                    Field to sort by (e.g., 'last_modified', 'created_at',
                    'name').
                  default: last_modified
                search_term:
                  type: string
                  nullable: true
                  description: Search term to filter monitors by name or description.
                per_page:
                  type: integer
                  description: Number of results per page. Defaults to 25.
                  default: 25
                page:
                  type: integer
                  description: Page number for pagination. Defaults to 1.
                  default: 1
                profile_id:
                  $ref: '#/components/schemas/profile_id'
      responses:
        '200':
          description: Successful response containing a paginated list of monitors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            description: Current page number.
                          per_page:
                            type: integer
                            description: Number of results per page.
                          total_entries:
                            type: integer
                            description: Total number of monitors.
                          total_pages:
                            type: integer
                            description: Total number of pages.
                          total_display_pages:
                            type: integer
                            description: Total number of display pages.
                          is_timeout:
                            type: boolean
                            description: Whether the query timed out.
                      monitors:
                        type: array
                        items:
                          type: object
                          properties:
                            monitor_id:
                              type: string
                              format: uuid
                              description: Unique identifier for the monitor.
                            name:
                              type: string
                              description: Name of the monitor.
                            description:
                              type: string
                              description: Description of the monitor.
                            detection_mode:
                              type: string
                              description: >-
                                Detection mode: 'company_first' or
                                'signal_first'.
                            signal_types:
                              type: array
                              items:
                                type: string
                              description: >-
                                Types of signals to monitor (e.g., 'jobs',
                                'news', 'advertisements').
                            signal_filters:
                              type: object
                              description: >-
                                Filters applied to signals. Uses the same filter
                                structure as the search endpoints.
                            company_filters:
                              type: object
                              description: >-
                                Filters applied to companies. Uses the same
                                filter structure as the search endpoints.
                            companies:
                              type: array
                              items:
                                type: string
                              description: Company identifiers.
                            is_company_enrichment:
                              type: boolean
                              description: Whether to enrich company data in results.
                            is_people_enrichment:
                              type: boolean
                              description: Whether to enrich people data in results.
                            people_enrichment_configs:
                              type: object
                              description: >-
                                Configuration for people enrichment, including
                                filters and limits.
                              properties:
                                max_people_to_return:
                                  type: integer
                                  description: >-
                                    Maximum number of people to return per
                                    company. Min: 1, Max: 25.
                            destination_type:
                              type: string
                              description: >-
                                Delivery destination type (e.g., 'email',
                                'webhook').
                            destination_config:
                              type: object
                              description: >-
                                Configuration for the delivery destination
                                (e.g., webhook URL, email address).
                            frequency_minute:
                              type: integer
                              description: >-
                                Trigger frequency in minutes. Min: 0, Max:
                                10080, Default: 0.
                            max_retry_per_trigger:
                              type: integer
                              description: >-
                                Maximum retries per trigger. Min: 0, Max: 3,
                                Default: 1.
                            max_records_per_trigger:
                              type: integer
                              description: >-
                                Maximum records per trigger. Min: 1, Max: 100,
                                Default: 25.
                            retry_delay_second:
                              type: integer
                              description: >-
                                Delay between retries in seconds. Min: 1, Max:
                                5, Default: 1.
                            max_daily_trigger:
                              type: integer
                              description: >-
                                Maximum triggers per day. Min: 0, Max: 86400,
                                Default: 500.
                            max_failure_trigger:
                              type: integer
                              description: >-
                                Maximum consecutive failures before pausing.
                                Min: 1, Max: 10, Default: 5.
                            masked_signature:
                              type: string
                              description: Masked webhook signature for display purposes.
                            is_active:
                              type: boolean
                              description: Whether the monitor is active.
                            is_paused:
                              type: boolean
                              description: Whether the monitor is paused.
                            notification_email:
                              type: string
                              description: Email address for monitor notifications.
                            repeated_failure_count:
                              type: integer
                              description: Current count of repeated consecutive failures.
                            last_trigger_at:
                              type: string
                              format: date-time
                              nullable: true
                              description: Timestamp of the last trigger.
                            last_processed_at:
                              type: string
                              format: date-time
                              nullable: true
                              description: Timestamp of the last completed processing.
                            masked_signature_display:
                              type: string
                              description: Masked webhook signature for display purposes.
                            created_at:
                              type: string
                              format: date-time
                              description: Timestamp when the monitor was created.
                            last_modified:
                              type: string
                              format: date-time
                              description: Timestamp when the monitor was last modified.
                            user:
                              type: object
                              properties:
                                user_id:
                                  type: string
                                  description: >-
                                    Identifier of the user who created the
                                    monitor.
                                nickname:
                                  type: string
                                  description: Display name of the user.
                                email:
                                  type: string
                                  description: Email of the user.
                              description: User who created the monitor.
                            total_trigger_today:
                              type: integer
                              description: Number of triggers executed today.
                            success_rate:
                              type: string
                              description: Overall success rate as a decimal string.
                            statistics:
                              type: object
                              properties:
                                total_triggers:
                                  type: integer
                                  description: Total number of triggers for this monitor.
                                total_success:
                                  type: integer
                                  description: Total number of successful triggers.
                                success_rate:
                                  type: number
                                  description: Overall success rate (0 to 1).
                              description: Aggregated statistics for this monitor.
              example:
                data:
                  pagination:
                    page: 1
                    per_page: 25
                    total_entries: 8
                    total_pages: 1
                    total_display_pages: 1
                    is_timeout: false
                  monitors:
                    - monitor_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                      name: Company First Monitor
                      description: null
                      detection_mode: company_first
                      signal_types:
                        - jobs
                        - news
                        - advertisements
                      signal_filters:
                        - filters:
                            locations:
                              - US
                          signal_type: jobs
                        - filters:
                            locations:
                              - US
                          signal_type: news
                        - filters:
                            target_locations:
                              - US
                          signal_type: advertisements
                      company_filters:
                        locations:
                          - US
                      companies:
                        - 67c4696b-b7b0-46b5-b2af-9f434543661e
                      is_company_enrichment: true
                      is_people_enrichment: true
                      people_enrichment_configs:
                        - filters:
                            people_locations:
                              - US
                          max_people_to_return: 3
                          people_contact_types:
                            - email-work
                      destination_type: webhook
                      destination_config:
                        webhook_url: https://usewebhook.com/example
                        headers:
                          X-Custom-Auth: your-token
                        body:
                          source: pubrio
                      notification_email: team@example.com
                      max_retry_per_trigger: 1
                      retry_delay_second: 1
                      max_records_per_trigger: 25
                      max_daily_trigger: 500
                      frequency_minute: 0
                      is_active: true
                      is_paused: false
                      max_failure_trigger: 5
                      repeated_failure_count: 0
                      last_trigger_at: '2026-04-05T22:29:36.349Z'
                      last_processed_at: '2026-04-05T18:28:05.715Z'
                      masked_signature: 9••••••••••••••••f09
                      created_at: '2026-04-03T18:49:20.048Z'
                      last_modified: '2026-04-05T22:29:36.349Z'
                      user:
                        user_id: a1b2c3d4-0000-0000-0000-000000000000
                        nickname: Jane Smith
                        email: jane@example.com
                      total_trigger_today: 4
                      success_rate: '1.000'
                    - ...
        '400':
          $ref: '#/components/responses/general_error'
        '429':
          $ref: '#/components/responses/rate_limit_error'
        '500':
          $ref: '#/components/responses/server_error'
components:
  schemas:
    profile_id:
      type: integer
      description: >-
        Optional. An identifier for the user profile (workspace) making the
        request. This is no longer required as the API key already includes your
        workspace information. If provided, it helps in associating the lookup
        with a specific user, allowing for data retrieval and credit tracking. 

         Check out `user details` endpoints under the Profile tab for more information.
  responses:
    general_error:
      description: >-
        Bad request. The request was malformed or contained invalid parameters.
        Check the error code and message for details.
      content:
        application/json:
          schema:
            required:
              - code
              - message
              - details
            type: object
            properties:
              code:
                example: 40001
                type: integer
              message:
                example: >-
                  Errors and codes will vary depending on the scenario, please
                  see the documentation for information.
                type: string
              details:
                type: object
    rate_limit_error:
      description: >-
        Rate limit exceeded. Too many requests were made in a given time period.
        Retry after the rate limit window resets.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: Request rate limit exceeded. Please wait and try again later.
                type: string
    server_error:
      description: >-
        Internal server error. An unexpected error occurred on the server.
        Contact support if the error persists.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: An unexpected error occurred on the server.
                type: string
  securitySchemes:
    pubrio_api_key:
      type: apiKey
      name: pubrio-api-key
      description: >-
        A unique API token that represents the actions you perform through the
        API and the corresponding permissions and operations. You can create it
        through the [Settings](https://dashboard.pubrio.com/#/settings/)
        section.
      in: header

````