Retrieve a single phone number | Close | Developer API Documentation

curl https://api.close.com/api/v1/phone_number/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "country": "US",
  "date_created": "2016-07-18T22:54:24.787000+00:00",
  "date_updated": "2016-07-18T22:55:55.938000+00:00",
  "id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
  "is_group_number": false,
  "is_premium": false,
  "is_verified": true,
  "label": "Primary Number",
  "mms_enabled": true,
  "number": "+16503335555",
  "number_formatted": "+1 650-333-5555",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "sms_enabled": true,
  "supports_mms_to_countries": [
    "CA",
    "US"
  ],
  "supports_sms_to_countries": [
    "CA",
    "US"
  ],
  "type": "internal",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "forward_to_enabled": false,
  "press_1_to_accept": false
}

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

address_idstring or null

bundle_idstring or null

carrierenum or null

Allowed values:

carrier_typeenum or null

The type of number the carrier has rented.

Allowed values:

countrystring or null

date_createddatetime

date_updateddatetime

idstring

is_group_numberboolean

is_premiumboolean

is_verifiedboolean

labelstring

last_billed_pricedouble or null

mms_enabledboolean

next_billing_ondatetime or null

numberstring

number_formattedstring

organization_idstring

sms_enabledboolean

supports_mms_to_countrieslist of strings

supports_sms_to_countrieslist of strings

typeenum

Allowed values:

user_idstring or null

forward_tostring or null

forward_to_enabledboolean

forward_to_formattedstring or null

participantslist of strings

phone_numberslist of strings

phone_numbers_formattedlist of strings

press_1_to_acceptboolean

voicemail_greeting_urlstring or null

was_portedboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error