esims

Get an eSIM subscriber

Returns the contact reference for a subscriber in this workspace. Contact details remain available through Contacts with its separate permissions.

get/v1/esim/subscribers/{subscriber_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/subscribers/{subscriber_id}
  • 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 requested resource.

idstring required
contact_idstring required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Changes

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