esims

Get the eSIM settings

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

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

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 workspace's eSIM settings.

credential_delivery_enabledboolean 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.

Changes

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