List monitors API
List monitors: GET /v1/monitors. Free per request.
GET /v1/monitors
GET /v1/monitors
List monitors.
- Cost: Free
- Cache: Not cached.
Parameters#
This endpoint takes no parameters of its own.
Every request also accepts:
cursor: the cursor from the previous page (Pagination).
Example request#
Set your key in the environment first (see Authentication).
1curl "https://api.socialscrape.dev/v1/monitors" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY"1import os2import requests34res = requests.get(5 "https://api.socialscrape.dev/v1/monitors",6 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},7)8body = res.json()910if body["ok"]:11 print(body["data"])12else:13 print(body["error"]["code"], body["error"]["message"])1const res = await fetch("https://api.socialscrape.dev/v1/monitors", {2 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },3});4const body = await res.json();56if (body.ok) {7 console.log(body.data);8} else {9 console.error(body.error.code, body.error.message);10}1{2 "nodes": [3 {4 "name": "SocialScrape List monitors",5 "type": "n8n-nodes-base.httpRequest",6 "typeVersion": 4.2,7 "position": [8 0,9 010 ],11 "parameters": {12 "method": "GET",13 "url": "https://api.socialscrape.dev/v1/monitors",14 "sendQuery": false,15 "sendHeaders": true,16 "headerParameters": {17 "parameters": [18 {19 "name": "x-api-key",20 "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"21 }22 ]23 }24 }25 }26 ],27 "connections": {}28}Example response#
This is a sample with illustrative values. Status 200.
200 OKSample response
1{2 "ok": true,3 "credits_charged": 0,4 "credits_remaining": 5000,5 "cached": false,6 "cached_at": null,7 "request_id": "req_e5c19e68e5a39343e18fba64",8 "data": {9 "object": "list",10 "items": [11 {12 "object": "monitor",13 "id": "mon_0123456789abcdef",14 "endpoint": "/v1/github/user/repositories",15 "params": {16 "handle": "torvalds"17 },18 "interval_minutes": 60,19 "webhook_url": "https://example.com/hook",20 "active": true,21 "created_at": "2026-10-29T14:00:00Z",22 "webhook_secret": null,23 "last_run_at": "2026-10-29T15:00:00Z",24 "next_run_at": "2026-10-29T16:00:00Z",25 "last_error": null26 }27 ],28 "cursor": null,29 "has_more": false30 },31 "cursor": null,32 "has_more": false33}Response#
A list of Monitor objects in data.items, with data.cursor and data.has_more.
See Data models for every field. The envelope around data is described in Responses.
Errors#
Failures are free: credits_charged is 0. Branch on error.code, never on the message.
| Code | HTTP | Retry | Meaning |
|---|
Every request can also fail with the account and platform errors listed on the Errors page.
Related endpoints#
- Create a monitor (
POST /v1/monitors) - Delete a monitor (
DELETE /v1/monitors/{monitor_id}) - Send a test event (
POST /v1/monitors/{monitor_id}/test) - Webhook delivery log (
GET /v1/monitors/{monitor_id}/deliveries) - Send an event again (
POST /v1/monitors/events/{event_id}/redeliver) - Monitor events (
GET /v1/monitors/events)