esims

List an eSIM's credential deliveries

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.

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

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The eSIM's deliveries.

Example response

{
  "data": [
    {
      "id": "edv_01krdgeqcxet5s7t44vh8rt9mg",
      "to": "traveler@example.com",
      "install_link": {
        "id": "eil_01krdgeqcxet5s7t44vh8rt9mg"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.