API v3

GET /incidents

Open incidents and planned maintenance (next 3 days) affecting this account's services.

Addresshttps://api.voicepro.plus/v3/incidents
Key permissionread

Fields

NameInType
limitqueryinteger
cursorquerystringnext_cursor from the previous page.

* required

Example

curl -X GET "https://api.voicepro.plus/v3/incidents" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "list",
  "data": [
    {
      "object": "incident",
      "id": "inc_20261021a",
      "title": "Delayed usage figures",
      "kind": "incident",
      "impact": "minor",
      "components": [
        "usage"
      ],
      "started_at": "2026-10-21T07:40:00Z",
      "resolved_at": "2026-10-21T08:25:00Z",
      "status_page_url": "https://status.voicepro.plus"
    }
  ],
  "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.
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 Account