Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Number Portout API

Number portout operations

Telnyx Number Portout API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Number Portout. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 11 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

14 operations 11 paths 12 schemas 9 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Number Portout API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 9 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Number Portout 14

Number portout operations

GET
/portouts
List portout requests
ListPortoutRequest 2 params → 200401404422
GET
/portouts/events
List all port-out events
listPortoutEvents 2 params → 200422500
GET
/portouts/events/{id}
Show a port-out event
showPortoutEvent 1 param → 200404500
POST
/portouts/events/{id}/republish
Republish a port-out event
republishPortoutEvent 1 param → 204404500
GET
/portouts/rejections/{portout_id}
List eligible port-out rejection codes for a specific order
ListPortoutRejections 2 params → 200404422500
GET
/portouts/reports
List port-out related reports
ListPortoutReports 2 params → 200422500
POST
/portouts/reports
Create a port-out related report
CreatePortoutReport body → 201422500
GET
/portouts/reports/{id}
Retrieve a report
GetPortoutReport 1 param → 200404500
GET
/portouts/{id}
Get a portout request
FindPortoutRequest 1 param → 200401404422
GET
/portouts/{id}/comments
List all comments for a portout request
FindPortoutComments 1 param → 200401404422
POST
/portouts/{id}/comments
Create a comment on a portout request
PostPortRequestComment 1 param body → 201401404422
GET
/portouts/{id}/supporting_documents
List supporting documents on a portout request
GetPortRequestSupportingDocuments 1 param → 201401404
POST
/portouts/{id}/supporting_documents
Create a list of supporting documents on a portout request
PostPortRequestSupportingDocuments 1 param body → 201401404422
PATCH
/portouts/{id}/{status}
Update Status
UpdatePortoutStatus 2 params body → 200401404422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are PortoutDetails (27 properties), WebhookPortoutStatusChanged (9 properties), WebhookPortoutFocDateChanged (9 properties), WebhookPortoutNewComment (9 properties). Each schema is shown below with its type and property counts.

ExportPortoutsCSVReport
object
The parameters for generating a port-outs CSV report.
1 property 1 required
PortoutComment
object
6 properties 4 required
Metadata
object
4 properties
PortOutSupportingDocument
object
7 properties 7 required
PortoutRejection
object
3 properties
WebhookPortoutFocDateChanged
object
9 properties
PortoutEvent
object
WebhookPortoutStatusChanged
object
9 properties
PortoutDetails
object
27 properties
PaginationMeta
object
4 properties
PortoutReport
object
8 properties
WebhookPortoutNewComment
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-number-portout-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API