---
title: "List an eSIM's credential deliveries"
method: GET
path: "/v1/esim/sims/{esim_id}/deliveries"
tags: ["esims"]
---

# List an eSIM's credential deliveries

`GET /v1/esim/sims/{esim_id}/deliveries`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/esim/sims/{esim_id}/deliveries`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns the credential deliveries sent for this eSIM, newest first (the most recent 50), each with its outcome. A delivery settles to `delivered` or `failed` and is also reported by the `esim.credentials.delivered` and `esim.credentials.delivery_failed` events carrying the same delivery id.

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The eSIM's deliveries.

- EsimDeliveryList: The eSIM's credential deliveries, newest first, most recent 50.
  - `data` EsimCredentialsDelivery[], required
    - `id` string, required
    - `channel` 'email' | 'sms', required: Channel the install credentials are delivered over.
    - `to` string, required: Recipient address the message goes to.
    - `status` 'pending' | 'delivered' | 'failed', required: Outcome of a credential delivery. - `pending`: accepted; the outcome has not settled. - `delivered`: the message reached the recipient's provider; terminal. - `failed`: the message could not be delivered; `failure_code` says why. Terminal.
    - `failure_code` string, nullable, required: Why the delivery failed. Null unless status is failed. Open enum: treat unrecognized values as future failure kinds.
    - `created_at` string, date-time, required: When the delivery was accepted.
    - `settled_at` string, date-time, nullable, required: When the outcome became known. Null while pending.
    - `install_link` EsimInstallLinkMetadata, required: Non-secret link details for identifying and revoking a delivered installation link. Contains no token or installation credentials.
      - `id` string, required
      - `expires_at` string, date-time, required: When the installation link expires.
      - `revoked_at` string, date-time, nullable, required: When the link was revoked, or null while not revoked.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6cec81ac4862?raw)