Bird

Bird Esims API

Prepaid travel eSIMs. Order, install, top up, and manage data connectivity for travelers.

Documentation GitHub OpenAPI

Operations 33

POST /v1/esim/orders Order a data package #

GET /v1/esim/orders List orders #

GET /v1/esim/orders/{order_id} Get an order #

POST /v1/esim/orders/{order_id}/cancel Cancel an unfunded order #

GET /v1/esim/offers/{offer_id}/checkout Get eSIM checkout options #

GET /v1/esim/offers/{offer_id}/recurrence Get recurring eSIM offer terms #

POST /v1/esim/subscriptions Create a recurring eSIM subscription #

GET /v1/esim/subscriptions List recurring eSIM subscriptions #

GET /v1/esim/subscriptions/{subscription_id} Get a recurring eSIM subscription #

GET /v1/esim/subscriptions/{subscription_id}/periods List recurring eSIM periods #

POST /v1/esim/subscriptions/{subscription_id}/cancel Cancel recurring eSIM renewal #

POST /v1/esim/subscribers Create an eSIM subscriber #

GET /v1/esim/subscribers List eSIM subscribers #

GET /v1/esim/subscribers/{subscriber_id} Get an eSIM subscriber #

GET /v1/esim/sims/{esim_id}/assignment Get an eSIM assignment #

POST /v1/esim/sims/{esim_id}/assignment Assign an eSIM to a person #

GET /v1/esim/sims List eSIMs #

GET /v1/esim/sims/{esim_id} Get an eSIM #

PATCH /v1/esim/sims/{esim_id} Update an eSIM #

DELETE /v1/esim/sims/{esim_id} Release an eSIM #

GET /v1/esim/sims/{esim_id}/credentials Get eSIM install credentials #

POST /v1/esim/sims/{esim_id}/credentials/deliver Send install credentials to the traveler #

GET /v1/esim/sims/{esim_id}/deliveries List an eSIM's credential deliveries #

POST /v1/esim/sims/{esim_id}/install-links Create a hosted install link #

DELETE /v1/esim/sims/{esim_id}/install-links/{install_link_id} Revoke a hosted install link #

GET /v1/esim/sims/{esim_id}/packages List an eSIM's data packages #

GET /v1/esim/sims/{esim_id}/packages/{package_id} Get a data package #

DELETE /v1/esim/sims/{esim_id}/packages/{package_id} Remove a data package #

GET /v1/esim/sims/{esim_id}/compatible-offers List offers an eSIM can take #

POST /v1/esim/sims/{esim_id}/suspend Suspend an eSIM #

POST /v1/esim/sims/{esim_id}/resume Resume an eSIM #

GET /v1/esim/settings Get the eSIM settings #

PATCH /v1/esim/settings Update the eSIM settings #

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bird:bird-esims-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bird Esims API
  version: 1.0.0
  description: 'Build communications into your applications and AI workflows with the Bird API.

    Explore endpoints for email, SMS, WhatsApp, verification, and realtime messaging.


    Start with the developer documentation, browse the

    API reference, or connect your agent through the

    Bird MCP server.


    Setting a `User-Agent` header is recommended but not required. Official Bird

    SDKs set it automatically (format: `bird-/`). The header is

    used for operational logging and customer-support diagnostics; the API never

    rejects requests that omit it.


    Rate limits are advertised on every response from a rate-limited endpoint as

    IETF `RateLimit` and `RateLimit-Policy` headers (Structured Fields per RFC

    9651; spec draft-ietf-httpapi-ratelimit-headers-11). On 429 responses, a

    `Retry-After` header in seconds is also returned. Clients should pace

    themselves against the `r` (remaining) and `t` (seconds until reset) params

    in the `RateLimit` header rather than only reacting to 429s.


    The deprecation policy explains how

    the API marks a deprecated field, query parameter, or body shape, including

    the `Deprecation` response header (RFC 9745).'
servers:
- url: https://{region}.platform.bird.com
  description: 'Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.

    '
  variables:
    region:
      default: us1
      enum:
      - us1
      - eu1
      description: The region your organization's data is hosted in.
- url: https://platform.bird.com
  description: Region-independent endpoint for authentication and account administration.
- url: http://localhost:8080
  description: Local development.
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (174 KB total) ---
# Full source: https://artifacts.apis.io/bird/openapi/bird-esims-api-openapi.yml

Bird Esims API

Operations 33

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification