---
title: "List eSIM subscribers"
method: GET
path: "/v1/esim/subscribers"
tags: ["esims"]
---

# List eSIM subscribers

`GET /v1/esim/subscribers`

## Request

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

Returns person references in this workspace, newest first. Filter by contact_id to find an existing subscriber.

## Query parameters

- `limit` integer
- `starting_after` string
- `ending_before` string
- `contact_id` string

## Headers

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

## Response `200`

The requested resource.

- EsimSubscriberList
  - `data` EsimSubscriber[], required: Subscribers in creation order, newest first.
    - `id` string, required
    - `contact_id` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `409`: Resource conflict
- `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/3e2a50466454?raw)