For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomepageProduct HelpLog inTry for Free
Developers HomeAPI ReferenceMCP
Developers HomeAPI ReferenceMCP
  • Getting Started
    • Introduction
    • Authentication with API Keys
    • Authentication with OAuth
    • API Clients
    • Pagination
    • Specifying Fields
    • Filter Parameters
    • HTTP Response Codes
    • Rate Limits
    • Timezone Offsets
    • Rich Text Fields
    • Changelog
  • CRM Core
    • Leads
    • Contacts
    • Opportunities
    • Tasks
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
    • Notes
    • Calls
    • Emails
    • Email Threads
    • WhatsApp Messages
    • Meetings
    • Custom Activities
    • Creations
    • Form Submissions
    • Lead Status Changes
    • Opportunity Status Changes
    • Lead Merges
    • Task Completions
  • Events & Webhooks
    • Webhooks
    • Events
  • Search & Reporting
    • Advanced Filtering
    • Smart Views
    • Reporting
  • Automation & Bulk Actions
    • Sequences (Workflows)
    • Bulk Actions
    • Exports
    • AI Field Enrichment
  • CRM Configuration
    • Custom Fields
    • Custom Activity Types
    • Custom Object Types
    • Pipelines
    • Opportunity Statuses
    • Lead Statuses
    • Integration Links
    • Forms
  • Communication Configuration
    • Email Templates
    • SMS Templates
    • Outcomes
    • Playbooks
    • Scheduling Links Guide
    • Scheduling Links
    • Connected Accounts
    • Send As
    • Unsubscribed Emails
    • Phone Numbers
      • GETList or search for phone numbers
      • POSTRequest an internal phone number
      • GETRetrieve a single phone number
      • PUTUpdate a phone number
      • DELDelete a phone number
    • Blocked Phone Numbers
    • Dialers
  • Users & Organizations
    • Users
    • Organizations
    • Memberships
    • Roles
    • Groups
Close

Product

OverviewCommunicationAutomationIntegrationsReportingSMSCallingSecurityForms

Pricing & Use Cases

PricingClose vs Other CRMsCustomer Stories

Resources

Sales BlogSales ResourcesSales GuidesWebinarsOn-Demand DemoSales Tools

Company

AboutCareersPartner with CloseBrand GuidelinesTermsPrivacyGDPRCCPA

Get Help

+1-833-GO-CLOSEHelp CenterDownload the Close AppProduct UpdatesSystem Status
LogoLogo
HomepageProduct HelpLog inTry for Free
Communication ConfigurationPhone Numbers

List or search for phone numbers

||View as Markdown|
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_group_number": false,
13      "is_premium": false,
14      "is_verified": true,
15      "label": "Primary Number",
16      "last_billed_price": null,
17      "mms_enabled": true,
18      "next_billing_on": null,
19      "number": "+16503335555",
20      "number_formatted": "+1 650-333-5555",
21      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
22      "sms_enabled": true,
23      "supports_mms_to_countries": [
24        "CA",
25        "US"
26      ],
27      "supports_sms_to_countries": [
28        "CA",
29        "US"
30      ],
31      "type": "internal",
32      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
33      "forward_to": null,
34      "forward_to_enabled": false,
35      "forward_to_formatted": null,
36      "participants": [],
37      "phone_numbers": [
38        "+16508889898"
39      ],
40      "phone_numbers_formatted": [
41        "+1 650-888-9898"
42      ],
43      "press_1_to_accept": false,
44      "voicemail_greeting_url": null,
45      "was_ported": false
46    },
47    {
48      "address_id": null,
49      "bundle_id": null,
50      "carrier": null,
51      "carrier_type": null,
52      "country": "US",
53      "date_created": "2016-07-18T22:54:24.787000+00:00",
54      "date_updated": "2016-07-18T22:55:55.938000+00:00",
55      "id": "phon_973589ev50ZKOqTVndOFN4effz092753608234569U3",
56      "is_group_number": false,
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      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
74      "forward_to": null,
75      "forward_to_enabled": false,
76      "forward_to_formatted": null,
77      "participants": [],
78      "phone_numbers": [],
79      "phone_numbers_formatted": [],
80      "press_1_to_accept": false,
81      "voicemail_greeting_url": null,
82      "was_ported": false
83    },
84    {
85      "address_id": null,
86      "bundle_id": null,
87      "carrier": null,
88      "carrier_type": null,
89      "country": "US",
90      "date_created": "2016-07-14T20:37:23.022000+00:00",
91      "date_updated": "2016-07-18T22:54:41.548000+00:00",
92      "id": "phon_324230958beOjoa6F42w5Hlkdjfg8p3wmIPnTuvNbaX",
93      "is_group_number": true,
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      "user_id": null,
114      "forward_to": null,
115      "forward_to_enabled": false,
116      "forward_to_formatted": null,
117      "participants": [
118        "user_OWiN4rEbBR04K2AKXe3jq5j1JWQqmTguuuZa1dG7qQr",
119        "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
120        "user_SJMF1fEyZGdtl2RPzCm9zVQ7qhd33VajdGDREhbsxjF"
121      ],
122      "phone_numbers": [],
123      "phone_numbers_formatted": [],
124      "press_1_to_accept": false,
125      "voicemail_greeting_url": null
126    }
127  ],
128  "has_more": false
129}
Was this page helpful?
Previous

Phone Numbers

Next

Request an internal phone number

Built with

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
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
is_group_numberboolean or nullOptional

Response

Successful response
datalist of objects
has_moreboolean

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error