---
title: "Get all SIM cards"
method: GET
path: "/sim_cards"
tags: ["SIM Cards"]
---

# Get all SIM cards

`GET /sim_cards`

Get all SIM cards belonging to the user that match the given filters.

## Query parameters

- `filter` object
  - `iccid` string — A search string to partially match for the SIM card's ICCID.
  - `msisdn` string — A search string to match for the SIM card's MSISDN.
  - `status` string[] — Filter by a SIM card's status.
  - `tags` string[] — A list of SIM card tags to filter on.<br/><br/> If the SIM card contains <b><i>all</i></b> of the given <code>tags</code> they will be found.<br/><br/> For example, if the SIM cards have the following tags: <ul> <li><code>['customers', 'staff', 'test']</code> <li><code>['test']</code></li> <li><code>['customers']</code></li> </ul> Searching for <code>['customers', 'test']</code> returns only the first because it's the only one with both tags.<br/> Searching for <code>test</code> returns the first two SIMs, because both of them have such tag.<br/> Searching for <code>customers</code> returns the first and last SIMs.<br/>
- `page` object
  - `number` integer — The page number to load.
  - `size` integer — The size of the page.
- `include_sim_card_group` boolean
- `filter[sim_card_group_id]` string, uuid
- `sort` 'current_billing_period_consumed_data.amount' | '-current_billing_period_consumed_data.amount'

## Response `200`

Successful response

- object
  - `data` SimpleSIMCard[]
    - `id` string, uuid — Identifies the resource.
    - `record_type` string
    - `status` SIMCardStatus
      - `value` 'registering' | 'enabling' | 'enabled' | 'disabling' | 'disabled' | 'data_limit_exceeded' | 'setting_standby' | 'standby' — The current status of the SIM card. It will be one of the following: <br/> <ul> <li><code>registering</code> - the card is being registered</li> <li><code>enabling</code> - the card is being enabled</li> <li><code>enabled</code> - the card is enabled and ready for use</li> <li><code>disabling</code> - the card is being disabled</li> <li><code>disabled</code> - the card has been disabled and cannot be used</li> <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li> <li><code>setting_standby</code> - the process to set the card in stand by is in progress</li> <li><code>standby</code> - the card is in stand by</li> </ul> Transitioning between the enabled and disabled states may take a period of time.
      - `reason` string — It describes why the SIM card is in the current status.
    - `type` 'physical' | 'esim' — The type of SIM card
    - `iccid` string — The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.
    - `imsi` string — SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). <br/> Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).
    - `msisdn` string — Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/> MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.
    - `sim_card_group_id` string, uuid — The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.
    - `tags` string[] — Searchable tags associated with the SIM card
    - `data_limit` object — The SIM card individual data limit configuration.
      - `amount` string
      - `unit` 'MB' | 'GB'
    - `current_billing_period_consumed_data` object — The SIM card consumption so far in the current billing cycle.
      - `amount` string
      - `unit` string
    - `actions_in_progress` boolean — Indicate whether the SIM card has any pending (in-progress) actions.
    - `created_at` string — ISO 8601 formatted date-time indicating when the resource was created.
    - `updated_at` string — ISO 8601 formatted date-time indicating when the resource was updated.
    - `esim_installation_status` 'released' | 'disabled', nullable — The installation status of the eSIM. Only applicable for eSIM cards.
    - `version` string — The version of the SIM card.
    - `resources_with_in_progress_actions` object[] — List of resources with actions in progress.
    - `eid` string, nullable — The Embedded Identity Document (eID) for eSIM cards.
    - `authorized_imeis` string[], nullable — List of IMEIs authorized to use a given SIM card.
    - `voice_enabled` boolean — Indicates whether voice services are enabled for the SIM card.
  - `meta` PaginationMeta
    - `total_pages` integer
    - `total_results` integer
    - `page_number` integer
    - `page_size` integer

## Other responses

- `401` — Unauthorized
- `default` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/8f5f4e537994/schema)