> ## Documentation Index > Fetch the complete documentation index at: https://help.withallo.com/llms.txt > Use this file to discover all available pages before exploring further. # Get eSIM > Returns the status of an eSIM you ordered. Use it to poll for readiness if you do not receive webhooks. Requires the `PARTNER` scope. **Required scope:** `PARTNER` Returns the status of an eSIM you ordered. The [`partner.esim.ready`](/en/v2/api-reference/webhooks/event-catalog#partneresimready) and [`partner.esim.failed`](/en/v2/api-reference/webhooks/event-catalog#partneresimfailed) webhooks tell you when the status changes. Without a webhook endpoint, poll this endpoint instead, within the [rate limit](/en/v2/api-reference/guides/rate-limits) of 20 read requests per second per key. | `status` | What it means | | - | - | | `PROVISIONING` | The eSIM is ordered and not ready yet. This usually takes 5 to 15 minutes. | | `ACTIVE` | The eSIM is ready. Calls to the number ring the eSIM. Get the [activation code](/en/v2/api-reference/partner/get-esim-activation-code) to deliver it to your client. | | `FAILED` | The order did not complete. `failure_code` gives the reason. | `failure_code` is `null` unless `status` is `FAILED`. You can only read eSIMs ordered on accounts your own API key created. Any other id fails with `PARTNER_ESIM_NOT_FOUND`. ## OpenAPI ````yaml GET /v2/api/partner/esims/{id} openapi: 3.0.3 info: title: Allo API description: >- Allo API provides programmatic access to your Allo account, allowing you to manage webhooks, retrieve calls and contacts, and send SMS messages. All requests to `/v1/api/**` endpoints automatically go through quota checking and scope validation. version: 1.0.0 contact: name: Allo Support servers: - url: https://api.withallo.com description: Production server security: [] tags: - name: Summary Templates description: >- Manage call summary templates that control how AI-generated call summaries are structured for your team. - name: Webhooks description: >- Manage webhook endpoints to receive real-time notifications about events in your Allo account. Each endpoint subscribes to one or more event topics and is verified with a signing secret. - name: Calls description: >- Retrieve and search call records with filtering and pagination. Filter calls by your Allo phone number. - name: Contacts description: >- Search and retrieve contact information with sorting and pagination. Includes engagement level tracking. - name: SMS description: Send SMS messages to phone numbers using your Allo numbers. - name: Phone Numbers description: Retrieve information about your Allo phone numbers. - name: Analytics description: Pre-computed call metrics, team performance, and outbound dial funnel - name: CRM description: Manage people, companies, and deals in your CRM. - name: Notes description: >- Internal team notes on conversations and CRM people, with @mention support. Notes are never visible to the contact. - name: Threads description: >- Team discussion threads attached to a conversation item (call, SMS, or conversation note). One thread per item. - name: AI Receptionist description: >- Read and write the AI receptionist configuration of a phone line: business details, voice, prompt, capabilities, business hours, transfer rules, scheduling calendars and knowledge sources. paths: /v2/api/partner/esims/{id}: get: tags: - Partner summary: Get eSIM description: >- Returns the status of an eSIM you ordered. Use it to poll for readiness if you do not receive webhooks. Requires the `PARTNER` scope. operationId: getPartnerEsim parameters: - name: id in: path required: true schema: type: string description: The eSIM id returned by Order eSIM (`eso-*`). responses: '200': description: eSIM content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: The eSIM id (`eso-*`). example: eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61 account_id: type: string description: The account the eSIM was ordered for. example: usr-575966AF3661061265263C58882BC409D2A427B8 partner_client_ref: type: string nullable: true description: Your own reference, set when the account was created. example: crm-12345 phone_number: type: string description: The number the eSIM carries. example: '+33745805999' tier: type: string description: The tier code that was ordered. example: ESIM_20GB status: type: string enum: - PROVISIONING - ACTIVE - FAILED description: >- `PROVISIONING`: ordered, not ready yet. `ACTIVE`: ready, calls to the number ring the eSIM. `FAILED`: the order did not complete, see `failure_code`. example: PROVISIONING failure_code: type: string nullable: true description: >- Why the order failed. Set only when `status` is `FAILED`. example: null created_at: type: string format: date-time description: When the eSIM was ordered. example: '2026-10-14T10:05:00' example: data: id: eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61 account_id: usr-575966AF3661061265263C58882BC409D2A427B8 partner_client_ref: crm-12345 phone_number: '+33745805999' tier: ESIM_20GB status: ACTIVE failure_code: null created_at: '2026-10-14T10:05:00' '401': $ref: '#/components/responses/ApiUnauthorized' '403': description: The API key lacks the PARTNER scope. content: application/json: schema: type: object properties: error: type: object '404': description: >- No eSIM with this id was ordered on an account your API key provisioned (PARTNER_ESIM_NOT_FOUND). content: application/json: schema: type: object properties: error: type: object '429': $ref: '#/components/responses/ApiRateLimited' security: - ApiKeyAuth: [] components: responses: ApiUnauthorized: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ApiError' ApiRateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' schemas: ApiError: type: object properties: error: type: object properties: type: type: string code: type: string message: type: string retryable: type: boolean request_id: type: string retry_after_seconds: type: integer nullable: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.