GET sim_cards

telnyx.com

Summary: Get all SIM cards
Operation ID: SimCardsGet
Auth: unknown
Description

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

Parameters (6)

filter[iccid] (string, query, optional)

A search string to partially match for the SIM card's ICCID.

filter[sim_card_group_id] (string, query, optional)

A valid SIM card group ID.

filter[tags] (array, query, optional)

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/>

include_sim_card_group (boolean, query, optional, default: False)

It includes the associated SIM card group object in the response when present.

page[number] (integer, query, optional, default: 1)

The page number to load.

Constraints: {'minimum': 1}

page[size] (integer, query, optional, default: 20)

The size of the page.

Constraints: {'minimum': 1, 'maximum': 250}

No probe data for this endpoint yet.