# Fetch phone number

**GET /v1/PhoneNumbers/{PhoneNumber}**


Detailed information on phone numbers

## Servers
- https://lookups.twilio.com: https://lookups.twilio.com ()


## Authentication methods
- Account sid auth token


## Parameters

### Path parameters
- **PhoneNumber** (string)
  The phone number to lookup in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.

### Query parameters
- **CountryCode** (string)
  The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.
- **Type** (array[string])
  The type of information to return. Can be: `carrier` or `caller-name`. The default is null. To retrieve both types of information, specify this parameter twice; once with `carrier` and once with `caller-name` as the value.
- **AddOns** (array[string])
  The `unique_name` of an Add-on you would like to invoke. Can be the `unique_name` of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about  Add-ons, see the [Add-ons documentation](https://www.twilio.com/docs/add-ons).
- **AddOnsData** (object(prefixed-collapsible-map-AddOns))
  Data specific to the add-on you would like to invoke. The content and format of this value depends on the add-on.


## Responses
### 200
OK
#### Headers
- **Access-Control-Allow-Origin** (string)
  Specify the origin(s) allowed to access the resource
- **Access-Control-Allow-Methods** (string)
  Specify the HTTP methods allowed when accessing the resource
- **Access-Control-Allow-Headers** (string)
  Specify the headers allowed when accessing the resource
- **Access-Control-Allow-Credentials** (boolean)
  Indicates whether the browser should include credentials
- **Access-Control-Expose-Headers** (string)
  Headers exposed to the client

#### Body: application/json (object)
- **caller_name** (object | null)
  The name of the phone number's owner. If `null`, that information was not available.
- **country_code** (string | null)
  The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number.
- **phone_number** (string(phone-number) | null)
  The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
- **national_format** (string | null)
  The phone number, in national format.
- **carrier** (object | null)
  The telecom company that provides the phone number.
- **add_ons** (object | null)
  A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons).
- **url** (string(uri) | null)
  The absolute URL of the resource.


[Powered by Bump.sh](https://bump.sh)