---
title: "Get the eSIM settings"
method: GET
path: "/v1/esim/settings"
tags: ["esims"]
---

# Get the eSIM settings

`GET /v1/esim/settings`

## Request

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

Returns your workspace’s eSIM settings, including defaults for fields you have not changed. Use the update operation to change them.

## Headers

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

## Response `200`

The workspace's eSIM settings.

- EsimSettings: The eSIM settings your workspace controls. Every field carries its effective value, whether or not the workspace has ever changed it.
  - `credential_delivery_enabled` boolean, required: Whether Bird automatically sends an install link after a new eSIM purchase with a linked contact. Uses the contact's email address, or SMS when only a phone number is available. Defaults to `false`. Manual install-link sends remain available regardless of this setting.

## 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/6dfce1179799?raw)