About this endpoint
What it does
Looks up details for a phone number and returns a JSON object containing the number, its geographic region, carrier, timezones, and number type.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| number | String | Yes | Phone number to look up. |
| country | String | No | Country code to use for lookup. Default: US. |
Response
Returns a JSON object with number, region, carrier, timezones, and number_type fields. The region and carrier fields are nullable strings, timezones is an array of strings, and number_type is a string.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| number | String | No | The phone number returned by the lookup. |
| region | String | No | Geographic region for the phone number, or null if unavailable. |
| carrier | String | No | Carrier name for the phone number, or null if unavailable. |
| timezones | String Array | No | Timezone names associated with the phone number. |
| number_type | String | No | The phone number type returned by the lookup. |