Port-in requests

Move numbers you have with another carrier to Ready. File the request in the app, where the account holder signs the letter of authorization. Then follow it here.

#List port-in requests

Your latest 20 requests to move numbers from another carrier to Ready, newest first. File a request in the app: the account holder signs the letter of authorization there. Needs the manage_phones permission.

Returns

The list is data.requests. The other keys under data only feed the app’s filing form.

data.requests[]object[]: Each { id, status, country, current_carrier, account_name, service_address, authorized_name, reason, cutover_on, created_at, updated_at, numbers }. numbers is a list of { phone_number, phone_id }; phone_id is the number id once it’s on Ready. The account number and PIN are never returned.
data.requests[].statusstring: submitted (waiting for Ready to file it; you can cancel), with_carrier, completed, rejected (see reason) or cancelled.
data.loaobject: For the app’s filing form: the letter of authorization it shows, { version, text }. Filing isn’t available over the API, so you can ignore it.
data.max_numbersinteger: For the app’s filing form: the most numbers one request can hold. You can ignore it.
data.max_lengthsobject: For the app’s filing form: the longest each form field may be. You can ignore it.

Errors

HTTP	Code	When
500	no code	Ready couldn’t load your requests. Try again.

curl "https://api.tryready.com/v1/port-requests" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/port-requests', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/port-requests",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "requests": [
      {
        "id": 31,
        "status": "with_carrier",
        "country": "US",
        "current_carrier": "Verizon",
        "account_name": "Acme Plumbing LLC",
        "service_address": "1 Main St, Denver, CO 80202",
        "authorized_name": "Jo Rivera",
        "reason": null,
        "cutover_on": "2026-11-20",
        "created_at": "2026-11-10T16:02:11.000Z",
        "updated_at": "2026-11-11T09:30:00.000Z",
        "numbers": [
          {
            "phone_number": "+13035550123",
            "phone_id": null
          }
        ]
      }
    ],
    "loa": {
      "version": "2026-11-08",
      "text": "..."
    },
    "max_numbers": 20
  }
}

#Cancel a port-in request

Cancels a request that’s still submitted, before Ready files it with the carrier. Needs the manage_phones permission.

Path parameters

idintegerRequired: The request id.

Errors

HTTP	Code	When
409	`not_cancellable`	It’s already with the carrier, closed, or not on your account.
500	no code	Ready couldn’t cancel it. Try again.

curl -X POST "https://api.tryready.com/v1/port-requests/31/cancel" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/port-requests/31/cancel', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/port-requests/31/cancel",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true
}