Skip to content

API reference/phone

Read a phone monitor and its last results

GET/api/v1/phone/monitors/{monitorId}

authentication
Secret API key as a bearer token
billing
Free.

The monitor plus results: the status of every number from the last run (valid, invalid, unassigned, unreachable or suppressed — an entry you put on your suppression list yourself, an import, your own failure or abuse reports or an opt-out, which is never counted as decay), keyed by the number as it was saved — its E.164, or the entry as typed where it does not parse — or null until the first run has finished. Beside it, flags maps the same numbers to the change flags that run raised ([] where nothing changed); it is null until a run has recorded them, which includes a monitor whose last run came before flags existed. A monitor that belongs to another account answers 404.

Parameters

name in type description
monitorIdrequiredpathintegerThe monitor's id from the list endpoint.

Example request

curl https://spaw.co/api/v1/phone/monitors/7 \
  -H "Authorization: Bearer sk_live_…"
const response = await fetch('https://spaw.co/api/v1/phone/monitors/7', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_live_…',
  },
});
const result = await response.json();
import requests

response = requests.get(
    'https://spaw.co/api/v1/phone/monitors/7',
    headers={'Authorization': 'Bearer sk_live_…'},
)
result = response.json()
$ch = curl_init('https://spaw.co/api/v1/phone/monitors/7');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_live_…'],
]);
$result = json_decode(curl_exec($ch), true);
from spaw import Client

client = Client('sk_live_…')
result = client.get_phone_monitor(7)
import Spaw from 'spaw';

const spaw = new Spaw({ apiKey: 'sk_live_…' });
const result = await spaw.getPhoneMonitor(7);
use Spaw\Client;

$spaw = new Client('sk_live_…');
$result = $spaw->getPhoneMonitor(7);

This endpoint has no console on its page. It answers with records from your own account, often by an id only you have, rather than about a value you can type here. The dashboard lists the same rows.

Responses

200The monitor.

{
    "success": true,
    "data": {
        "monitor": {
            "id": 7,
            "name": "SMS audience",
            "cadence": "monthly",
            "number_count": 2,
            "country": "GB",
            "live_check": false,
            "next_run_at": "2026-10-05T08:00:00+00:00",
            "last_run_at": "2026-09-05T08:00:12+00:00",
            "last_summary": {
                "total": 2,
                "valid": 1,
                "invalid": 0,
                "unassigned": 1,
                "unreachable": 0,
                "suppressed": 0,
                "changed": 0,
                "decayed": 0,
                "newly_flagged": 1,
                "credits_used": 1,
                "stopped_reason": null
            },
            "created_at": "2026-08-27T08:00:00+00:00",
            "results": {
                "+447911012345": "valid",
                "+442030130018": "unassigned"
            },
            "flags": {
                "+447911012345": [
                    "became_disposable"
                ],
                "+442030130018": []
            }
        }
    }
}

401The key is missing, malformed, or revoked.

{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

404No such record on this account.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "No record with that id on this account.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

429Over 5 requests per second for the key. Retry after the limit resets.

{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

Error codes

Failures answer { success: false, error: { code, message, request_id } }. Each code has its own page.

markdown version·openapi.json