API v3

GET /sims

Mobile SIMs with this month's usage.

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

Fields

NameInType
limitqueryinteger
cursorquerystringnext_cursor from the previous page.
statusqueryactive | suspended
holderquerystringHolder name contains.

* required

Example

curl -X GET "https://api.voicepro.plus/v3/sims?status=active" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "list",
  "data": [
    {
      "object": "sim",
      "id": "sim_K7M2Q9",
      "label": "Warehouse van 3",
      "plan_name": "Business+ Essentials",
      "add_ons": [
        "EU Roaming"
      ],
      "iccid": "8944500102345678901",
      "phone_number": "+447700900123",
      "country": "GB",
      "status": "active",
      "holder_name": "Sam Taylor",
      "data_cap_gb": 30,
      "created_at": "2026-10-02T09:14:00Z",
      "activated_at": "2026-10-02T11:40:00Z",
      "month_to_date": {
        "data_bytes": 4831838208,
        "roaming_bytes": 214748364,
        "calls": 42,
        "sms": 17,
        "countries": [
          "GB",
          "FR"
        ]
      },
      "data_as_of": "2026-10-28T08:55:00Z"
    }
  ],
  "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 SIMs