API v3
GET /number_watches
The account's number watches, newest first.
Addresshttps://api.voicepro.plus/v3/number_watches
Key permissionread
Fields
| Name | In | Type | |
|---|---|---|---|
| limit | query | integer | |
| cursor | query | string | next_cursor from the previous page. |
* required
Example
curl -X GET "https://api.voicepro.plus/v3/number_watches" \ -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
"object": "list",
"data": [
{
"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"
}
],
"has_more": false,
"next_cursor": null
}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.
invalid_parameter400: A query parameter or body field has a bad value; param names it.
missing_parameter400: A required parameter or field is missing; param names it.
unknown_parameter400: A parameter or field that this endpoint does not accept; param names it.
invalid_json400: The body is not valid JSON.
invalid_cursor400: The cursor is malformed, expired or from a different list.
invalid_time_range400: from or to is not an ISO 8601 date-time, or to is not after from.
range_too_long400: The time range is longer than this endpoint allows (stated in the endpoint).
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.