API v3

GET /number_watches/{id}

One number watch, with the number's answer at the last check.

Addresshttps://api.voicepro.plus/v3/number_watches/{id}
Key permissionread

Fields

NameInType
id *pathstring

* required

Example

curl -X GET "https://api.voicepro.plus/v3/number_watches/nw_6f1c2a9e0b7d4c3e8a5f1b2c3d4e5f60" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "number_watch",
  "id": "nw_6f1c2a9e0b7d4c3e8a5f1b2c3d4e5f60",
  "phone_number": "+447700900123",
  "label": "Supplier hotline",
  "products": [
    "nrv",
    "last_port"
  ],
  "created_at": "2026-10-29T09:12:44Z",
  "last_checked_at": "2026-10-30T05:13:20Z",
  "last_change_at": null,
  "current": {
    "validity": "valid",
    "ported": "false",
    "range_holder": "Example Mobile"
  },
  "currency": "GBP"
}

Errors

Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.

missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
route_not_found404: No such path in v3.
resource_not_found404: No object with that id on this account.
service_not_enabled404: The account does not have this service (voice trunk, IoT, numbers); param names it.
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
internal_error500: Our fault. Quote the request_id to support.

More in Dips