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

AT&T Porting API

The Porting API from AT&T — 3 operation(s) for porting.

AT&T Porting API is one of 14 APIs that AT&T publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Porting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 5 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

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

5 operations 3 paths 6 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.att.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

AT&T Porting API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes.

  • oauth2 — AT&T OAuth 2.0 with user consent via authorization code flow

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Porting 5
POST
/portabilityOrder
AT&T Create Port Order
createPortabilityOrder body → 201400401
GET
/portabilityOrder
AT&T List Port Orders
listPortabilityOrders 3 params → 200401
GET
/portabilityOrder/{id}
AT&T Get Port Order Status
getPortabilityOrder 1 param → 200404401
PATCH
/portabilityOrder/{id}
AT&T Update Port Order
updatePortabilityOrder 1 param body → 200404401
POST
/cancelPortabilityOrder
AT&T Cancel Port Order
cancelPortabilityOrder body → 201400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (4 properties), PortabilityOrder (4 properties), PortabilityOrderCancellation (3 properties), CancelPortabilityOrder (2 properties). Each schema is shown below with its type and property counts.

PortabilityOrder
object
4 properties
PortabilityOrderUpdate
object
1 property
PortabilityOrderCreate
object
1 property
CancelPortabilityOrder
object
2 properties
ErrorResponse
object
4 properties
PortabilityOrderCancellation
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

at-and-t-porting-api-openapi.yml Raw ↑

Other APIs AT&T publishes across the network.

AT&T OAuth 2.0 API
AT&T Alliance Wireline APIs
AT&T Authentication API
AT&T Balance Management API
AT&T Device Management API
AT&T Geographic Sites API
AT&T Inbox Management API
AT&T Messages API
AT&T Number Management API
AT&T Product Orders API
AT&T Service Management API
AT&T SMS Messaging API