v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 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

numberinteger

The page number to load

sizeinteger

The size of the page

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

action'keep' | 'disconnect'

Filter results by action type

phone_numberstring

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

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

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

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"
}

Response

Successful response

Example response

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