Skip to main content
POST
/
monitors
List monitors
curl --request POST \
  --url https://api.pubrio.com/monitors \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "destination_type": [
    "<string>"
  ],
  "detection_mode": [
    "<string>"
  ],
  "is_active": true,
  "is_paused": true,
  "is_ascending_order": false,
  "order_by": "last_modified",
  "search_term": "<string>",
  "per_page": 25,
  "page": 1,
  "profile_id": 123
}
'
{
  "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": "[email protected]",
        "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": "[email protected]"
        },
        "total_trigger_today": 4,
        "success_rate": "1.000"
      },
      "..."
    ]
  }
}

Authorizations

​
pubrio-api-key
string
header
required

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 section.

Body

application/json
​
destination_type
string[]

Filter by destination types (e.g., ['email', 'webhook']). Empty array returns all.

​
detection_mode
string[]

Filter by detection modes (e.g., ['company_first', 'signal_first']). Empty array returns all.

​
is_active
boolean

Filter by active status.

​
is_paused
boolean

Filter by paused status.

​
is_ascending_order
boolean
default:false

Sort in ascending order. Defaults to false (descending).

​
order_by
string
default:last_modified

Field to sort by (e.g., 'last_modified', 'created_at', 'name').

​
search_term
string | null

Search term to filter monitors by name or description.

​
per_page
integer
default:25

Number of results per page. Defaults to 25.

​
page
integer
default:1

Page number for pagination. Defaults to 1.

​
profile_id
integer

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.

Response

Successful response containing a paginated list of monitors.

​
data
object