v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Porting Orders

List all associated phone numbers

Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected.

get/porting_orders/{porting_order_id}/associated_phone_numbers

Path parameters

porting_order_idstring uuid required

Identifies the Porting Order associated with the phone numbers

Query parameters

phone_numberstring

Filter results by a phone number. It should be in E.164 format.

action'keep' | 'disconnect'

Filter results by action type

Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]

{
  "phone_number": "+441234567890",
  "action": "keep"
}

value'-created_at' | 'created_at'

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

Consolidated sort parameter (deepObject style). Originally: sort[value]

{
  "value": "-created_at"
}

page[number]integer

page[size]integer

Response

Successful response

Example response

{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "porting_order_id": "a24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "GB",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+441234567890",
        "end_at": "+441234567899"
      },
      "action": "keep",
      "record_type": "porting_associated_phone_number",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}