Retrieve a single phone number

GET

https://api.close.com/api/v1/phone_number/:id/

GET

/api/v1/phone_number/:id/

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

1 {
2   "address_id": null,
3   "bundle_id": null,
4   "carrier": null,
5   "carrier_type": null,
6   "country": "US",
7   "date_created": "2016-07-18T22:54:24.787000+00:00",
8   "date_updated": "2016-07-18T22:55:55.938000+00:00",
9   "id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
10   "is_group_number": false,
11   "is_premium": false,
12   "is_verified": true,
13   "label": "Primary Number",
14   "last_billed_price": null,
15   "mms_enabled": true,
16   "next_billing_on": null,
17   "number": "+16503335555",
18   "number_formatted": "+1 650-333-5555",
19   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
20   "sms_enabled": true,
21   "supports_mms_to_countries": [
22     "CA",
23     "US"
24   ],
25   "supports_sms_to_countries": [
26     "CA",
27     "US"
28   ],
29   "type": "internal",
30   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
31   "forward_to": null,
32   "forward_to_enabled": false,
33   "forward_to_formatted": null,
34   "press_1_to_accept": false,
35   "voicemail_greeting_url": null
36 }

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

{
  "address_id": null,
  "bundle_id": null,
  "carrier": null,
  "carrier_type": null,
  "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",
  "last_billed_price": null,
  "mms_enabled": true,
  "next_billing_on": null,
  "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": null,
  "forward_to_enabled": false,
  "forward_to_formatted": null,
  "press_1_to_accept": false,
  "voicemail_greeting_url": null
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

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

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

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

1	{
2	"address_id": null,
3	"bundle_id": null,
4	"carrier": null,
5	"carrier_type": null,
6	"country": "US",
7	"date_created": "2016-07-18T22:54:24.787000+00:00",
8	"date_updated": "2016-07-18T22:55:55.938000+00:00",
9	"id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
10	"is_group_number": false,
11	"is_premium": false,
12	"is_verified": true,
13	"label": "Primary Number",
14	"last_billed_price": null,
15	"mms_enabled": true,
16	"next_billing_on": null,
17	"number": "+16503335555",
18	"number_formatted": "+1 650-333-5555",
19	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
20	"sms_enabled": true,
21	"supports_mms_to_countries": [
22	"CA",
23	"US"
24	],
25	"supports_sms_to_countries": [
26	"CA",
27	"US"
28	],
29	"type": "internal",
30	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
31	"forward_to": null,
32	"forward_to_enabled": false,
33	"forward_to_formatted": null,
34	"press_1_to_accept": false,
35	"voicemail_greeting_url": null
36	}