Skip to main content

List SIM card pools

GET 
/sim_card_pools

This API allows listing a paginated collection of SIM Card Pools . It allows to explore a collection of existing asynchronous operation using specific filters.

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    filter[name] string

    Possible values: [sim_card_pool, foobar]

    Filter by pool name.

Responses ​

200: Successful Response

Schema

    data

    object[]

  • Array [

    • matching_id string
    name string
    description string
    activation_code string
    invalid_at string

    Expiration date of the sim card pool resource

    organization_id uuid

    The user ID that created the SIM Card Pool

    user_id uuid

    The user ID that created the SIM Card Pool

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/sim_card_pools' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "matching_id": "QR-G-K9-2N7-JHRTNX",
      "name": "sim card pool",
      "description": "sim card pool description",
      "activation_code": "LPA:1$rsp.truphone.com$QR-G-K9-7NG-1H9FLVT",
      "invalid_at": "2018-02-02T22:25:27.521Z",
      "organization_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "user_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "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
  }
}