Skip to main content
GET
/
sim_card_groups
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const simCardGroupListResponse of client.simCardGroups.list()) {
  console.log(simCardGroupListResponse.id);
}
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_group",
      "default": true,
      "name": "My Test Group",
      "data_limit": {
        "amount": "2048.1",
        "unit": "MB"
      },
      "consumed_data": {
        "unit": "MB",
        "amount": "2048.1"
      },
      "sim_card_count": 10,
      "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "wireless_blocklist_id": "5aa584f6-14b1-41b2-8e01-1c04d1ee77c1",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[number]
integer
default:1

The page number to load.

Required range: x >= 1
​
page[size]
integer
default:20

The size of the page.

Required range: 1 <= x <= 250
​
filter[name]
string<uuid>

A valid SIM card group name.

Example:

"1119e3cb-f39d-4254-ad38-9080d5fe90a9"

​
filter[private_wireless_gateway_id]
string<uuid>

A Private Wireless Gateway ID associated with the group.

Example:

"7606c6d3-ff7c-49c1-943d-68879e9d584d"

​
filter[wireless_blocklist_id]
string<uuid>

A Wireless Blocklist ID associated with the group.

Example:

"0f3f490e-c4d3-4cf5-838a-9970f10ee259"

Response

Successful Response

​
data
SIMCardGroup · object[]
​
meta
object