API v3

GET /events/{id}

One event from the last 30 days.

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

Fields

NameInType
id *pathstring

* required

Example

curl -X GET "https://api.voicepro.plus/v3/events/evt_3f9c2a71b8e04d6a9c1e5b27" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "event",
  "id": "evt_3f9c2a71b8e04d6a9c1e5b27",
  "type": "invoice.issued",
  "occurred_at": "2026-10-29T09:00:00Z",
  "data": {
    "id": "INV-26-10AB12",
    "period": "2026-10",
    "totalGbp": 42,
    "dueAt": "2026-11-12T00:00:00.000Z"
  }
}

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 Webhooks