Get all SIM cards

GET 
/wireless/sim_cards

Returns a list of all your sim cards

Request

Query Parameters

page[number] number

Current page based on pagination settings.

page[size] number

Number of results to return per page based on pagination settings.

filter[sim_card_tags] string[]

A list of SIM card tags to filter on.

filter[sim_card_id] uuid

A valid SIM card ID.

filter[sim_card_iccid] string

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

filter[sim_card_group_id] uuid

A valid SIM card group ID.

filter[sim_card_group_name] string

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

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

enabled boolean

Whether the SIM card is currently enabled or not

iccid string

The ICCID of the given card

id string

The id of the SIM card

sim_card_group

object

The SIM card group associated with the given card

id string

The id of the SIM card group

data_allocation string

The total data allocation for the group in GB

ingress_site_id string

The id of the site where data will enter the network

egress_site_id string

The id of the site where data will exit the network

created_at string

Timestamp for when the order was created

updated_at string

Timestamp for when the order was last updated

The SIM card group associated with the given card

tags string[]

The searchable tags associated with the SIM card

updated_at string

Timestamp for when the SIM card was last updated

]

metadata

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

{
  "data": [
    {
      "enabled": true,
      "iccid": "string",
      "id": "string",
      "sim_card_group": {
        "id": "string",
        "data_allocation": "string",
        "ingress_site_id": "string",
        "egress_site_id": "string",
        "created_at": "string",
        "updated_at": "string"
      },
      "tags": [
        "string"
      ],
      "updated_at": "string"
    }
  ],
  "metadata": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Loading...