Skip to navigation
Phone NumbersLookup

Look up phone number

View as MarkdownOpen in Claude

Returns validity and formatting information for any supplied E.164 phone number, with optional carrier and caller-name data. Use it to normalize or enrich a number before other workflows; it neither searches purchasable inventory nor returns numbers owned by the project. Use Search phone numbers or List phone numbers for those jobs.

Permissions

No API token scope is required to make a successful request to this endpoint.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

e164_numberstringRequired
The phone number in E.164 format.

Query parameters

includestringOptional

Further number information to include in the response, some of which are billable. You can specify: carrier (Lookup full carrier information for the number), cnam (Lookup Caller ID information for the number). Separate multiple values with a comma: include=carrier,cnam.

Response

The request has succeeded.
country_code_numberintegerOptional
The Country code associated with the number.
national_numberstringOptional
Number in the countries national format.
possible_numberbooleanOptional
Whether the number supplied is a possible number.
valid_numberbooleanOptional
Whether the number supplied is a valid number.
national_number_formattedstringOptional
The E164 number formatted in national format.
international_number_formattedstringOptional
The E164 number formatted in international format.
e164stringOptional
The number in E164 format.
locationstringOptional
The location of the number based on its area code and NPA.
country_codestringOptional
The ISO3166 alpha 2 country code associated with the number.
timezoneslist of stringsOptional
The time zones associated with the number.
number_typestringOptional
The type of number based on its area code and NPA.
carrierobjectOptional

Carrier information. Adding include=carrier to your request will do a live lookup to determine the current carrier information about this number.

cnamobjectOptional

Caller ID information. Adding include=cnam to your request will do a live lookup to determine the current caller ID information about this number.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error