Get all SIM card groups

gethttps://api.telnyx.com/v2/sim_card_groups

Get all SIM card groups 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_card_groups?page[number]=1&page[size]=20"

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
filter[name]
string
(uuid)
optional
A valid SIM card group name.
Example: "My Test Group"
filter[private_wireless_gateway_id]
string
(uuid)
optional
A Private Wireless Gateway ID associated with the group.
Example: "7606c6d3-ff7c-49c1-943d-68879e9d584d"

Responses

200
Successful response
default
Unexpected error

Success Response

{
  "data": [
    {
      "consumed_data": {
        "amount": "2048.1",
        "unit": "MB"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "data_limit": {
        "amount": "2048.1",
        "unit": "MB"
      },
      "default": true,
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "name": "My Test Group",
      "private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_group",
      "sim_card_count": 10,
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/sim_card_groups

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/sim_card_groups/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/sim_card_groups/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/sim_card_groups/{id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/sim_card_groups/{id}/actions/set_private_wireless_gateway

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/sim_card_groups/{id}/actions/remove_private_wireless_gateway

...

...

Parameters

Responses

Success Response

Was this page helpful?