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

const client = new Telnyx({
  apiKey: 'My API Key',
});

const simCardOrders = await client.simCardOrders.list();

console.log(simCardOrders.data);
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_order",
      "quantity": 21,
      "cost": {
        "amount": "2.52",
        "currency": "USD"
      },
      "order_address": {
        "id": "1293384261075731499",
        "street_address": "600 Congress Avenue",
        "extended_address": "14th Floor",
        "locality": "Austin",
        "administrative_area": "TX",
        "country_code": "US",
        "postal_code": "78701"
      },
      "tracking_url": "http://www.example.com/",
      "status": "pending",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

filter
object

Consolidated filter parameter for SIM card orders (deepObject style). Originally: filter[created_at], filter[updated_at], filter[quantity], filter[cost.amount], filter[cost.currency], filter[address.id], filter[address.street_address], filter[address.extended_address], filter[address.locality], filter[address.administrative_area], filter[address.country_code], filter[address.postal_code]

page
object

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

Response

Successful Response

data
SIMCardOrder · object[]
meta
object