Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

List an eSIM's credential deliveries

GET
/v1/esim/sims/{esim_id}/deliveries
bird esim deliveries list <esim-id>
Response200
{
  "data": [
    {
      "id": "edv_01krdgeqcxet5s7t44vh8rt9mg",
      "channel": "email",
      "to": "traveler@example.com",
      "status": "pending",
      "failure_code": "invalid_recipient",
      "install_link": {
        "id": "eil_01krdgeqcxet5s7t44vh8rt9mg"
      }
    }
  ]
}

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.

Parameters

esim_idstring

Identifier of the eSIM.

Response Payload

data
array of object
required
Show child attributes
data.id
string
required
data.channel
string
required
data.to
string
required

Recipient address the message goes to.

data.status
string
required
data.failure_code
nullable string
required

Why the delivery failed. Null unless status is failed. Open enum: treat unrecognized values as future failure kinds.

Possible values (may grow over time): invalid_recipient, suppressed, blocked, bounced, channel_unavailable, send_failed

data.created_at
string
required

When the delivery was accepted.

data.settled_at
nullable string
required

When the outcome became known. Null while pending.

data.install_link
nullable object
required

Link metadata for explicit revocation. Null for deliveries created before hosted links were enabled.

Show child attributes
data.install_link.id
string
required
data.install_link.expires_at
string
required

When the installation link expires.

data.install_link.revoked_at
nullable string
required

When the link was revoked, or null while not revoked.

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief