Get all SIM cards
gethttps://api.telnyx.com/v2/sim_cardsGet all SIM cards belonging to the user that match the given filters.
curl -X GET \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--globoff "https://api.telnyx.com/v2/sim_cards?page[size]=10&filter[tags][]=region_5&filter[tags][]=ext_cards"Parameters
In Query
page[number]
integer
(1)optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)optional
The size of the page
Default:
20
include_sim_card_group
boolean
optional
It includes the associated SIM card group object in the response when present.
Example: truefilter[sim_card_group_id]
string
(uuid)optional
A valid SIM card group ID.
Example: "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"filter[tags]
array of string
optional
A list of SIM card tags to filter on.
If the SIM card contains all of the given
For example, if the SIM cards have the following tags:
Searching for
Searching for
If the SIM card contains all of the given
tags they will be found.For example, if the SIM cards have the following tags:
['customers', 'staff', 'test']['test']['customers']
['customers', 'test'] returns only the first because it's the only one with both tags.Searching for
test returns the first two SIMs, because both of them have such tag.Searching for
customers returns the first and last SIMs.filter[iccid]
string
optional
A search string to partially match for the SIM card's ICCID.
Example: "89310410106543789301"filter[status]
array of string
optional
Filter by a SIM card's status.
Responses
200
Successful response
default
Unexpected error
Success Response
{
"data": [
{
"created_at": "2018-02-02T22:25:27.521Z",
"current_billing_period_consumed_data": {
"amount": "2049.0",
"unit": "MB"
},
"data_limit": {
"amount": "2048.0",
"unit": "MB"
},
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": {
"reason": "The SIM card is active, ready to connect to networks and consume data.",
"value": "enabled"
},
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Previous:
SIM Card OrdersWas this page helpful?