Telnyx API — Porting Orders

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Porting Orders
  description: 'Telnyx API — Porting Orders. 53 operations. Lead operation: List all porting events. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Porting Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-porting-orders
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Porting Orders business capability. Self-contained, no shared references.
    resources:
    - name: porting-events
      path: /porting/events
      operations:
      - name: listportingevents
        method: GET
        description: List all porting events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id],
            filter[created_at][gte], filter[created_at][lte]'
    - name: porting-events-id
      path: /porting/events/{id}
      operations:
      - name: showportingevent
        method: GET
        description: Show a porting event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the porting event.
          required: true
    - name: porting-events-id-republish
      path: /porting/events/{id}/republish
      operations:
      - name: republishportingevent
        method: POST
        description: Republish a porting event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the porting event.
          required: true
    - name: porting-loa_configurations
      path: /porting/loa_configurations
      operations:
      - name: listloaconfigurations
        method: GET
        description: List LOA configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createloaconfiguration
        method: POST
        description: Create a LOA configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting-loa_configurations-preview
      path: /porting/loa_configurations/preview
      operations:
      - name: previewloaconfigurationparams
        method: POST
        description: Preview the LOA configuration parameters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting-loa_configurations-id
      path: /porting/loa_configurations/{id}
      operations:
      - name: deleteloaconfiguration
        method: DELETE
        description: Delete a LOA configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a LOA configuration.
          required: true
      - name: getloaconfiguration
        method: GET
        description: Retrieve a LOA configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a LOA configuration.
          required: true
      - name: updateloaconfiguration
        method: PATCH
        description: Update a LOA configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a LOA configuration.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting-loa_configurations-id-preview
      path: /porting/loa_configurations/{id}/preview
      operations:
      - name: previewloaconfiguration
        method: GET
        description: Preview a LOA configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a LOA configuration.
          required: true
    - name: porting-reports
      path: /porting/reports
      operations:
      - name: listportingreports
        method: GET
        description: List porting related reports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]'
      - name: createportingreport
        method: POST
        description: Create a porting related report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting-reports-id
      path: /porting/reports/{id}
      operations:
      - name: getportingreport
        method: GET
        description: Retrieve a report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a report.
          required: true
    - name: porting-uk_carriers
      path: /porting/uk_carriers
      operations:
      - name: listportingukcarriers
        method: GET
        description: List available carriers in the UK
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders
      path: /porting_orders
      operations:
      - name: listportingorders
        method: GET
        description: List all porting orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference],
            filter[parent_support_key], filter[p'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createportingorder
        method: POST
        description: Create a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: porting_orders-exception_types
      path: /porting_orders/exception_types
      operations:
      - name: listexceptiontypes
        method: GET
        description: List all exception types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-phone_number_configurations
      path: /porting_orders/phone_number_configurations
      operations:
      - name: listphonenumberconfigurations
        method: GET
        description: List all phone number configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][],
            filter[porting_phone_number][in][], filter[user_bundle_id][in]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createphonenumberconfigurations
        method: POST
        description: Create a list of phone number configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-id
      path: /porting_orders/{id}
      operations:
      - name: deleteportingorder
        method: DELETE
        description: Delete a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getportingorder
        method: GET
        description: Retrieve a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateportingorder
        method: PATCH
        description: Edit a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: porting_orders-id-actions-activate
      path: /porting_orders/{id}/actions/activate
      operations:
      - name: activateportingorder
        method: POST
        description: Activate every number in a porting order asynchronously.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-actions-cancel
      path: /porting_orders/{id}/actions/cancel
      operations:
      - name: cancelportingorder
        method: POST
        description: Cancel a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-actions-confirm
      path: /porting_orders/{id}/actions/confirm
      operations:
      - name: confirmportingorder
        method: POST
        description: Submit a porting order.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-actions-share
      path: /porting_orders/{id}/actions/share
      operations:
      - name: shareportingorder
        method: POST
        description: Share a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-id-activation_jobs
      path: /porting_orders/{id}/activation_jobs
      operations:
      - name: listportingorderactivationjobs
        method: GET
        description: List all porting activation jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-activation_jobs-activationJobId
      path: /porting_orders/{id}/activation_jobs/{activationJobId}
      operations:
      - name: getportingordersactivationjob
        method: GET
        description: Retrieve a porting activation job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateportingordersactivationjob
        method: PATCH
        description: Update a porting activation job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-id-additional_documents
      path: /porting_orders/{id}/additional_documents
      operations:
      - name: listadditionaldocuments
        method: GET
        description: List additional documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[document_type]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createadditionaldocuments
        method: POST
        description: Create a list of additional documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-id-additional_documents-additional_document_id
      path: /porting_orders/{id}/additional_documents/{additional_document_id}
      operations:
      - name: deleteadditionaldocument
        method: DELETE
        description: Delete an additional document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: additional_document_id
          in: path
          type: string
          description: Additional document identification.
          required: true
    - name: porting_orders-id-allowed_foc_windows
      path: /porting_orders/{id}/allowed_foc_windows
      operations:
      - name: listallowedfocwindows
        method: GET
        description: List allowed FOC dates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-comments
      path: /porting_orders/{id}/comments
      operations:
      - name: listportingordercomments
        method: GET
        description: List all comments of a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createportingordercomment
        method: POST
        description: Create a comment for a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: porting_orders-id-loa_template
      path: /porting_orders/{id}/loa_template
      operations:
      - name: getportingorderloatemplate
        method: GET
        description: Download a porting order loa template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loa_configuration_id
          in: query
          type: string
          description: The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration
            will be used.
    - name: porting_orders-id-requirements
      path: /porting_orders/{id}/requirements
      operations:
      - name: listportingorderrequirements
        method: GET
        description: List porting order requirements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-sub_request
      path: /porting_orders/{id}/sub_request
      operations:
      - name: getportingordersubrequest
        method: GET
        description: Retrieve the associated V1 sub_request_id and port_request_id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: porting_orders-id-verification_codes
      path: /porting_orders/{id}/verification_codes
      operations:
      - name: listverificationcodes
        method: GET
        description: List verification codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[verified]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
    - name: porting_orders-id-verification_codes-send
      path: /porting_orders/{id}/verification_codes/send
      operations:
      - name: sendportingverificationcodes
        method: POST
        description: Send the verification codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-id-verification_codes-verify
      path: /porting_orders/{id}/verification_codes/verify
      operations:
      - name: verifyportingverificationcodes
        method: POST
        description: Verify the verification code for a list of phone numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-porting_order_id-action_requirements
      path: /porting_orders/{porting_order_id}/action_requirements
      operations:
      - name: listportingactionrequirements
        method: GET
        description: List action requirements for a porting order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: The ID of the porting order
          required: true
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id],
            filter[action_type], filter[status]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
    - name: porting_orders-porting_order_id-action_requirements-id-initiate
      path: /porting_orders/{porting_order_id}/action_requirements/{id}/initiate
      operations:
      - name: initiateportingactionrequirement
        method: POST
        description: Initiate an action requirement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: The ID of the porting order
          required: true
        - name: id
          in: path
          type: string
          description: The ID of the action requirement
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-porting_order_id-associated_phone_numbers
      path: /porting_orders/{porting_order_id}/associated_phone_numbers
      operations:
      - name: listportingassociatedphonenumbers
        method: GET
        description: List all associated phone numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone numbers
          required: true
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createportingassociatedphonenumber
        method: POST
        description: Create an associated phone number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-porting_order_id-associated_phone_numbers-id
      path: /porting_orders/{porting_order_id}/associated_phone_numbers/{id}
      operations:
      - name: deleteportingassociatedphonenumber
        method: DELETE
        description: Delete an associated phone number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number
          required: true
        - name: id
          in: path
          type: string
          description: Identifies the associated phone number to be deleted
          required: true
    - name: porting_orders-porting_order_id-phone_number_blocks
      path: /porting_orders/{porting_order_id}/phone_number_blocks
      operations:
      - name: listportingphonenumberblocks
        method: GET
        description: List all phone number blocks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number blocks
          required: true
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createportingphonenumberblock
        method: POST
        description: Create a phone number block
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number block
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-porting_order_id-phone_number_blocks-id
      path: /porting_orders/{porting_order_id}/phone_number_blocks/{id}
      operations:
      - name: deleteportingphonenumberblock
        method: DELETE
        description: Delete a phone number block
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number block
          required: true
        - name: id
          in: path
          type: string
          description: Identifies the phone number block to be deleted
          required: true
    - name: porting_orders-porting_order_id-phone_number_extensions
      path: /porting_orders/{porting_order_id}/phone_number_extensions
      operations:
      - name: listportingphonenumberextensions
        method: GET
        description: List all phone number extensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number extensions
          required: true
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]'
        - name: sort
          in: query
          type: object
          description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
      - name: createportingphonenumberextension
        method: POST
        description: Create a phone number extension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number extension
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: porting_orders-porting_order_id-phone_number_extensions-id
      path: /porting_orders/{porting_order_id}/phone_number_extensions/{id}
      operations:
      - name: deleteportingphonenumberextension
        method: DELETE
        description: Delete a phone number extension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: porting_order_id
          in: path
          type: string
          description: Identifies the Porting Order associated with the phone number extension
          required: true
        - name: id
          in: path
          type: string
          description: Identifies the phone number extension to be deleted
          required: true
    - name: porting_phone_numbers
      path: /porting_phone_numbers
      operations:
      - name: listportingphonenumbers
        method: GET
        description: List all porting phone numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]'
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-porting-orders-rest
    port: 8080
    description: REST adapter for Telnyx API — Porting Orders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/porting/events
      name: porting-events
      description: REST surface for porting-events.
      operations:
      - method: GET
        name: listportingevents
        description: List all porting events
        call: telnyx-porting-orders.listportingevents
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/events/{id}
      name: porting-events-id
      description: REST surface for porting-events-id.
      operations:
      - method: GET
        name: showportingevent
        description: Show a porting event
        call: telnyx-porting-orders.showportingevent
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/events/{id}/republish
      name: porting-events-id-republish
      description: REST surface for porting-events-id-republish.
      operations:
      - method: POST
        name: republishportingevent
        description: Republish a porting event
        call: telnyx-porting-orders.republishportingevent
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/loa-configurations
      name: porting-loa-configurations
      description: REST surface for porting-loa_configurations.
      operations:
      - method: GET
        name: listloaconfigurations
        description: List LOA configurations
        call: telnyx-porting-orders.listloaconfigurations
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createloaconfiguration
        description: Create a LOA configuration
        call: telnyx-porting-orders.createloaconfiguration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/loa-configurations/preview
      name: porting-loa-configurations-preview
      description: REST surface for porting-loa_configurations-preview.
      operations:
      - method: POST
        name: previewloaconfigurationparams
        description: Preview the LOA configuration parameters
        call: telnyx-porting-orders.previewloaconfigurationparams
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/loa-configurations/{id}
      name: porting-loa-configurations-id
      description: REST surface for porting-loa_configurations-id.
      operations:
      - method: DELETE
        name: deleteloaconfiguration
        description: Delete a LOA configuration
        call: telnyx-porting-orders.deleteloaconfiguration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getloaconfiguration
        description: Retrieve a LOA configuration
        call: telnyx-porting-orders.getloaconfiguration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateloaconfiguration
        description: Update a LOA configuration
        call: telnyx-porting-orders.updateloaconfiguration
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/loa-configurations/{id}/preview
      name: porting-loa-configurations-id-preview
      description: REST surface for porting-loa_configurations-id-preview.
      operations:
      - method: GET
        name: previewloaconfiguration
        description: Preview a LOA configuration
        call: telnyx-porting-orders.previewloaconfiguration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/porting/reports
      name: porting-reports
      description: REST surface for porting-reports.
      operations:
      - method: GET
        name: listportingreports
        description: List porting related reports
        call: tel

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/capabilities/telnyx-porting-orders.yaml