---
title: "Retrieve telephone number availability"
method: GET
path: "/v2/partition/{partitionId}/telephonenumber/{tn}/availability"
tags: ["Telephone Number"]
---

# Retrieve telephone number availability

`GET /v2/partition/{partitionId}/telephonenumber/{tn}/availability`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/telephonenumber/{tn}/availability`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/telephonenumber/:tn/availability/get.ts> (a function with typed inputs; its response is checked against the schema)

Use to retrieve information about telephone number availability.<br/><br/> This does NOT check whether a telephone number is currently in use somewhere in the system, with the aim of determining it can be assigned; rather, it checks that the partition is configured to work with the rate center to which the telephone number belongs.  If this reports no availability, but you are sure that the partition should be able to support the telephone number, please check the partition rate center setup.<br/><br/> This is most likely to be used in pre-validation of a telephone number port request; however, the porting flow documentation recommends use of another endpoint which accomplishes the same thing. While this endpoint is not officially deprecated, we do recommend you reference and use the other endpoint <a href="#/~operation/Rate%20Center%20Inventory/getRateCenter">here</a>.

## Path parameters

- `partitionId` string, required
- `tn` string, required

## Response `200`

Successful operation

- TelephoneNumberAvailabilityX
  - `prefix` string
  - `reorderName` string
  - `originalReorderName` string
  - `name` string
  - `abbrName` string
  - `msa` string
  - `zips` string[]
  - `wireless` boolean
  - `state` string
  - `country` string
  - `portable` boolean
  - `serviceAvailable` boolean
  - `inboundCarrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER'

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)