Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
in-porting
Get subscription in-porting
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/in-porting \
  --header 'X-Api-Key: <api-key>'
{
  "msisdn": "+15551234567",
  "status": "PENDING",
  "direction": "INBOUND",
  "details": {
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "accountNumber": "<string>",
    "passcode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "scheduledAt": "2023-12-25",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
subscriptionId
string
required

The identifier of the subscription. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-subscription-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Response

Porting information retrieved successfully.

A request to port a number into or out of the system.

​
msisdn
string
required

The phone number to be ported, in E.164 format.

Example:

"+15551234567"

​
status
enum<string>
required

Current status of the porting process.

Available options:
PENDING,
IN_PROGRESS,
SCHEDULED,
COMPLETED,
FAILED
​
direction
enum<string>
required

The direction of the number porting, either inbound (to us) or outbound (from us).

Available options:
INBOUND,
OUTBOUND
​
details
USPortingDetails · object
required

description: Detailed information required for the porting process, varying by country and provider.

​
createdAt
string<date-time>
required

The timestamp when the porting request was created.

​
scheduledAt
string<date>

The date when the porting is scheduled to occur.

​
updatedAt
string<date-time>

The timestamp of the last update to the porting request.