List or search for phone numbers

GET

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

GET

/api/v1/phone_number/

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

1 {
2   "data": [
3     {
4       "address_id": null,
5       "bundle_id": null,
6       "carrier": null,
7       "carrier_type": null,
8       "country": "US",
9       "date_created": "2016-07-18T22:54:24.787000+00:00",
10       "date_updated": "2016-07-18T22:55:55.938000+00:00",
11       "id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
12       "is_premium": false,
13       "is_verified": true,
14       "label": "Primary Number",
15       "last_billed_price": null,
16       "mms_enabled": true,
17       "next_billing_on": null,
18       "number": "+16503335555",
19       "number_formatted": "+1 650-333-5555",
20       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
21       "sms_enabled": true,
22       "supports_mms_to_countries": [
23         "CA",
24         "US"
25       ],
26       "supports_sms_to_countries": [
27         "CA",
28         "US"
29       ],
30       "type": "internal",
31       "is_group_number": false,
32       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
33       "forward_to": null,
34       "forward_to_enabled": false,
35       "forward_to_formatted": null,
36       "inbound_ring_duration": null,
37       "participants": [],
38       "phone_numbers": [
39         "+16508889898"
40       ],
41       "phone_numbers_formatted": [
42         "+1 650-888-9898"
43       ],
44       "press_1_to_accept": false,
45       "voicemail_greeting_url": null,
46       "was_ported": false
47     },
48     {
49       "address_id": null,
50       "bundle_id": null,
51       "carrier": null,
52       "carrier_type": null,
53       "country": "US",
54       "date_created": "2016-07-18T22:54:24.787000+00:00",
55       "date_updated": "2016-07-18T22:55:55.938000+00:00",
56       "id": "phon_973589ev50ZKOqTVndOFN4effz092753608234569U3",
57       "is_premium": false,
58       "is_verified": true,
59       "label": "My Personal Cell",
60       "last_billed_price": null,
61       "mms_enabled": true,
62       "next_billing_on": null,
63       "number": "+14151231234",
64       "number_formatted": "+1 415-123-1234",
65       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
66       "sms_enabled": false,
67       "supports_mms_to_countries": [
68         "CA",
69         "US"
70       ],
71       "supports_sms_to_countries": [],
72       "type": "external",
73       "is_group_number": false,
74       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
75       "forward_to": null,
76       "forward_to_enabled": false,
77       "forward_to_formatted": null,
78       "participants": [],
79       "phone_numbers": [],
80       "phone_numbers_formatted": [],
81       "press_1_to_accept": false,
82       "voicemail_greeting_url": null,
83       "was_ported": false
84     },
85     {
86       "address_id": null,
87       "bundle_id": null,
88       "carrier": null,
89       "carrier_type": null,
90       "country": "US",
91       "date_created": "2016-07-14T20:37:23.022000+00:00",
92       "date_updated": "2016-07-18T22:54:41.548000+00:00",
93       "id": "phon_324230958beOjoa6F42w5Hlkdjfg8p3wmIPnTuvNbaX",
94       "is_premium": false,
95       "is_verified": true,
96       "label": "Group Number",
97       "last_billed_price": null,
98       "mms_enabled": true,
99       "next_billing_on": null,
100       "number": "+16508881234",
101       "number_formatted": "+1 650-888-1234",
102       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
103       "sms_enabled": true,
104       "supports_mms_to_countries": [
105         "CA",
106         "US"
107       ],
108       "supports_sms_to_countries": [
109         "CA",
110         "US"
111       ],
112       "type": "internal",
113       "is_group_number": true,
114       "user_id": null,
115       "forward_to": null,
116       "forward_to_enabled": false,
117       "forward_to_formatted": null,
118       "inbound_ring_duration": null,
119       "participants": [
120         "user_OWiN4rEbBR04K2AKXe3jq5j1JWQqmTguuuZa1dG7qQr",
121         "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
122         "user_SJMF1fEyZGdtl2RPzCm9zVQ7qhd33VajdGDREhbsxjF"
123       ],
124       "phone_numbers": [],
125       "phone_numbers_formatted": [],
126       "press_1_to_accept": false,
127       "voicemail_greeting_url": null
128     }
129   ],
130   "has_more": false
131 }

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.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

_fieldsstringOptional

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

numberstring or nullOptional

user_idstring or nullOptional

Deprecated. Use participant_user_id instead. The distinction between personal and group numbers is being removed, and user_id will be removed in a future update.

is_group_numberboolean or nullOptional

Deprecated. Use participant_user_id instead. The distinction between personal and group numbers is being removed, and is_group_number will be removed in a future update.

participant_user_idstring or nullOptional

Return numbers the given user participates in, including both personal and group numbers they belong to.

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error