GET /sim_card_orders

telnyx.com

Summary: Get all SIM card orders
Operation ID: SimCardOrdersGet
Auth: unknown
Description

Get all SIM card orders according to filters.

Parameters (14)

filter[address.administrative_area] (string, query, optional)

Filter by state or province where the address is located.

filter[address.country_code] (string, query, optional)

Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.

filter[address.extended_address] (string, query, optional)

Returns entries with matching name of the supplemental field for address information.

filter[address.id] (string, query, optional)

Uniquely identifies the address for the order.

filter[address.locality] (string, query, optional)

Filter by the name of the city where the address is located.

filter[address.postal_code] (string, query, optional)

Filter by postal code for the address.

filter[address.street_address] (string, query, optional)

Returns entries with matching name of the street where the address is located.

filter[cost.amount] (string, query, optional)

The total monetary amount of the order.

filter[cost.currency] (string, query, optional)

Filter by ISO 4217 currency string.

filter[created_at] (string, query, optional)

Filter by ISO 8601 formatted date-time string matching resource creation date-time.

filter[quantity] (integer, query, optional)

Filter orders by how many SIM cards were ordered.

filter[updated_at] (string, query, optional)

Filter by ISO 8601 formatted date-time string matching resource last update date-time.

page[number] (integer, query, optional, default: 1)

The page number to load.

Constraints: {'minimum': 1}

page[size] (integer, query, optional, default: 20)

The size of the page.

Constraints: {'minimum': 1, 'maximum': 250}

No probe data for this endpoint yet.