Skip to main content
GET
/
monitors
List monitors
curl --request GET \
  --url https://xquik.com/api/v1/monitors \
  --header 'x-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Free - does not consume credits
curl -X GET https://xquik.com/api/v1/monitors \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq -c '.monitors[] | {
    monitor_id: .id,
    username,
    x_user_id: .xUserId,
    event_types: .eventTypes,
    is_active: .isActive,
    created_at: .createdAt,
    next_billing_at: .nextBillingAt,
    monitor_detail_endpoint: ("/api/v1/monitors/" + .id),
    events_endpoint: ("/api/v1/events?monitorId=" + .id),
    event_detail_endpoint_pattern: "/api/v1/events/{event_id}",
    webhooks_endpoint: "/api/v1/webhooks",
    deliveries_endpoint_pattern: "/api/v1/webhooks/{webhook_id}/deliveries"
  }'
The Node.js, Python, and Go examples convert each account monitor into one inventory row. Store monitor_id, username, x_user_id, event_types, is_active, next_billing_at, monitor_detail_endpoint, events_endpoint, event_detail_endpoint_pattern, webhooks_endpoint, and deliveries_endpoint_pattern for backfills, support handoff, and webhook delivery audits.

​
Inventory handoff

Use GET /monitors after create, update, pause, or delete operations to rebuild your account monitor inventory. The response returns up to 200 monitors ordered by creation time and a total count for the returned set.

Tracked Accounts

Store each monitor’s id, username, and xUserId with downstream CRM, warehouse, or queue records.

Detail Handoff

Use Get Monitor with each id when a support workflow needs the latest event filter, active state, or billing checkpoint for one account monitor.

Active Billing

Filter monitors where isActive is true. Each active account monitor bills 21 credits per active monitor-hour; use nextBillingAt to schedule credit checks or pause stale alerts.

Webhook Alignment

Compare each monitor’s eventTypes with List Webhooks before relying on signed alerts.

Event Backfill

Use id as monitorId with List Events to audit stored account monitor events. Use returned event IDs with Get Event when a workflow needs the full tweet payload.

Delivery Audit

Use List Deliveries for each webhook and join delivery streamEventId to event IDs. Do not use x_event_id as the delivery join key.

State Repair

Use Update Monitor to replace eventTypes or toggle isActive. Use Delete Monitor only when the tracked account should stop permanently.

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

​
Response

​
monitors
object[]
Array of monitor objects.
​
monitors[].id
string
Unique monitor ID.
​
monitors[].username
string
Normalized X username.
​
monitors[].xUserId
string
Resolved X user ID.
​
monitors[].eventTypes
string[]
Subscribed event types.
​
monitors[].isActive
boolean
Whether the monitor is currently active.
​
monitors[].createdAt
string
ISO 8601 creation timestamp.
​
monitors[].nextBillingAt
string
Next hourly credit charge time for active monitor billing.
​
total
number
Total number of monitors.
{
  "monitors": [
    {
      "id": "7",
      "username": "elonmusk",
      "xUserId": "44196397",
      "eventTypes": ["tweet.new", "tweet.reply"],
      "isActive": true,
      "createdAt": "2026-02-24T10:30:00.000Z",
      "nextBillingAt": "2026-02-24T11:30:00.000Z"
    },
    {
      "id": "12",
      "username": "xquik_",
      "xUserId": "1849726401547751424",
      "eventTypes": ["tweet.new", "tweet.quote", "tweet.reply", "tweet.retweet"],
      "isActive": true,
      "createdAt": "2026-02-25T14:00:00.000Z",
      "nextBillingAt": "2026-02-25T15:00:00.000Z"
    }
  ],
  "total": 2
}
Returns up to 200 monitors. There is no pagination. Contact support if you need more.
Related: Create Monitor to add a new monitor, Get Monitor to fetch one monitor, List Events to audit stored events, Get Event to inspect one event, List Webhooks to compare subscriptions, or List Deliveries to audit webhook delivery status.
Last modified on May 21, 2026