---
title: "Get eSIM"
method: GET
path: "/v2/api/partner/esims/{id}"
tags: ["Partner"]
---

# Get eSIM

`GET /v2/api/partner/esims/{id}`

## Request

- Base URL: `https://api.withallo.com`
- URL: `https://api.withallo.com/v2/api/partner/esims/{id}`
- Auth: API key in header `Authorization`

Returns the status of an eSIM you ordered. Use it to poll for readiness if you do not receive webhooks. Requires the `PARTNER` scope.

## Path parameters

- `id` string, required

## Response `200`

eSIM

- object
  - `data` object
    - `id` string: The eSIM id (`eso-*`).
    - `account_id` string: The account the eSIM was ordered for.
    - `partner_client_ref` string, nullable: Your own reference, set when the account was created.
    - `phone_number` string: The number the eSIM carries.
    - `tier` string: The tier code that was ordered.
    - `status` 'PROVISIONING' | 'ACTIVE' | 'FAILED': `PROVISIONING`: ordered, not ready yet. `ACTIVE`: ready, calls to the number ring the eSIM. `FAILED`: the order did not complete, see `failure_code`.
    - `failure_code` string, nullable: Why the order failed. Set only when `status` is `FAILED`.
    - `created_at` string, date-time: When the eSIM was ordered.

## Other responses

- `401`: Invalid or missing API key
- `403`: The API key lacks the PARTNER scope.
- `404`: No eSIM with this id was ordered on an account your API key provisioned (PARTNER_ESIM_NOT_FOUND).
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `46c77103dd14`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/withallo/apis/allo-api/changes/v2/api/partner/esims/:id/get.md)

---

[API](https://skmtc.dev/withallo/apis/allo-api.md) - [All operations](https://skmtc.dev/withallo/apis/allo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/withallo/apis/allo-api/revisions/46c77103dd14?raw)