Skip to main content

List all phone number configurations

GET 
/porting_orders/phone_number_configurations

Returns a list of phone number configurations paginated.

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[porting_order_id] uuid

    Filter results by porting order id

    filter[porting_order_id][in][] uuid[]

    Filter results by a list of porting order ids

    filter[porting_order.status] string

    Possible values: [activation-in-progress, cancel-pending, cancelled, draft, exception, foc-date-confirmed, in-process, ported, submitted]

    Filter results by a specific porting order status

    filter[porting_order.status][in][] string[]

    Possible values: [activation-in-progress, cancel-pending, cancelled, draft, exception, foc-date-confirmed, in-process, ported, submitted]

    Filter results by specific porting order statuses

    filter[porting_phone_number] uuid

    Filter results by a specific porting phone number ID

    filter[porting_phone_number][in][] uuid[]

    Filter results by a list of porting phone number IDs

    filter[user_bundle_id] uuid

    Filter results by a specific user bundle ID

    filter[user_bundle_id][in][] uuid[]

    Filter results by a list of user bundle IDs

    sort[] string

    Possible values: [created_at, -created_at]

    Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this phone number configuration

    user_bundle_id uuid

    Identifies the associated user bundle

    porting_phone_number_id uuid

    Identifies the associated porting phone number

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

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

Response samples

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "user_bundle_id": "daa4308e-742f-4867-97f2-3073db13319a",
      "porting_phone_number_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_phone_number_configuration",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}