API v3
GET /iot/sims/{id}/esim
The SIM's eSIM profile state (for example RELEASED, DOWNLOADED, ENABLED); null for a physical SIM.
Addresshttps://api.voicepro.plus/v3/iot/sims/{id}/esim
Key permissionread
Fields
| Name | In | Type | |
|---|---|---|---|
| id * | path | string |
* required
Example
curl -X GET "https://api.voicepro.plus/v3/iot/sims/sim_7k2mqqxw4hd3nvbc5rtfz6ya/esim" \ -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
"object": "iot_esim",
"sim_id": "sim_7k2mqqxw4hd3nvbc5rtfz6ya",
"profile_status": null,
"data_as_of": "2026-10-28T09:01:00Z"
}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).
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.
upstream_unavailable503: A network partner or data service behind this endpoint is unavailable.
network_action_unavailable503: This network action is not switched on for the account yet (for example SIM suspend).
internal_error500: Our fault. Quote the request_id to support.
service_unavailable503: API v3 itself is briefly unavailable (for example a configuration problem on our side); the rest of VoicePro is unaffected. Retry later.