> For a complete page index, fetch https://developer.close.com/llms.txt

# List or search for phone numbers

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

Reference: https://developer.close.com/api/resources/phone-numbers/list

## Authentication

- `Authorization` header (basic auth, required) — Use your API key as the username and leave the password empty.
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `_limit` (integer, optional, default: 100) — Number of results to return.
- `_skip` (integer, optional, default: 0) — Number of results to skip before returning, for pagination.
- `_fields` (string, optional) — Comma-separated list of fields to include in the response.
- `number` (string, optional, nullable)
- `user_id` (string, optional, nullable) — 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_number` (boolean, optional, nullable) — 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_id` (string, optional, nullable) — Return numbers the given user participates in, including both personal and group numbers they belong to.

## Response

### 200

Successful response

- `data` (list of object, required)
  - `address_id` (string, required, nullable)
  - `bundle_id` (string, required, nullable)
  - `carrier` (enum, required, nullable)
    - Allowed values: `twilio`, `plivo`
  - `carrier_type` (enum, required, nullable)
    - Allowed values: `local`, `national`, `mobile`, `tollfree`, `shortcode`
  - `country` (string, required, nullable)
  - `date_created` (datetime, required)
  - `date_updated` (datetime, required)
  - `id` (string, required)
  - `is_premium` (boolean, required)
  - `is_verified` (boolean, required)
  - `label` (string, required)
  - `last_billed_price` (double, required, nullable)
  - `mms_enabled` (boolean, required)
  - `next_billing_on` (datetime, required, nullable)
  - `number` (string, required)
  - `number_formatted` (string, required)
  - `organization_id` (string, required)
  - `sms_enabled` (boolean, required)
  - `supports_mms_to_countries` (list of string, required)
  - `supports_sms_to_countries` (list of string, required)
  - `type` (enum, required)
    - Allowed values: `internal`, `external`, `virtual`
  - `is_group_number` (boolean, required, deprecated) — This field is deprecated and will be removed in a future update. Until then, it is set to `false` when the phone number has exactly one member (as defined by the `participants` field) and doesn't have any of the "shared" configuration set up (e.g. a phone menu, lead-based routing, a non-default ring order, etc.), and `true` otherwise.
  - `user_id` (string, required, nullable, deprecated) — This field is deprecated. See the `participants` field instead to learn who's assigned to this phone number. This `user_id` field will be removed in a future update. Until then, it is set to a specific user ID *only if* the given phone number has a single participant and no additional "shared" configuration (e.g. a phone menu, lead-based routing, a non-default ring order, etc.).
  - `forward_to` (string, optional, nullable)
  - `forward_to_enabled` (boolean, optional)
  - `forward_to_formatted` (string, optional, nullable)
  - `inbound_ring_duration` (integer, optional, nullable) — Number of seconds we ring this number on inbound calls before moving on (e.g. to voicemail). `null` means the default of 30 seconds is used.
  - `participants` (list of string, optional) — Every member of the phone number, as user IDs. If this field is absent, see `user_id` for the sole member.
  - `phone_numbers` (list of string, optional) — Present unless the phone number has exactly one member and no shared-number configuration (a phone menu, lead-based routing, a dial-out list, or a non-default ring order).
  - `phone_numbers_formatted` (list of string, optional) — Present under the same condition as `phone_numbers`, with each value formatted for display.
  - `press_1_to_accept` (boolean, optional)
  - `voicemail_greeting_url` (string, optional, nullable)
  - `was_ported` (boolean, optional)
- `has_more` (boolean, required)

## Errors

### 400 Bad Request Error

Bad request

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 404 Not Found Error

Not found

- `any`

## Examples

**Response**

```json
{
  "data": [
    {
      "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_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",
      "is_group_number": false,
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "inbound_ring_duration": null,
      "participants": [],
      "phone_numbers": [
        "+16508889898"
      ],
      "phone_numbers_formatted": [
        "+1 650-888-9898"
      ],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null,
      "was_ported": false
    },
    {
      "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_973589ev50ZKOqTVndOFN4effz092753608234569U3",
      "is_premium": false,
      "is_verified": true,
      "label": "My Personal Cell",
      "last_billed_price": null,
      "mms_enabled": true,
      "next_billing_on": null,
      "number": "+14151231234",
      "number_formatted": "+1 415-123-1234",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "sms_enabled": false,
      "supports_mms_to_countries": [
        "CA",
        "US"
      ],
      "supports_sms_to_countries": [],
      "type": "external",
      "is_group_number": false,
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "participants": [],
      "phone_numbers": [],
      "phone_numbers_formatted": [],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null,
      "was_ported": false
    },
    {
      "address_id": null,
      "bundle_id": null,
      "carrier": null,
      "carrier_type": null,
      "country": "US",
      "date_created": "2016-07-14T20:37:23.022000+00:00",
      "date_updated": "2016-07-18T22:54:41.548000+00:00",
      "id": "phon_324230958beOjoa6F42w5Hlkdjfg8p3wmIPnTuvNbaX",
      "is_premium": false,
      "is_verified": true,
      "label": "Group Number",
      "last_billed_price": null,
      "mms_enabled": true,
      "next_billing_on": null,
      "number": "+16508881234",
      "number_formatted": "+1 650-888-1234",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "sms_enabled": true,
      "supports_mms_to_countries": [
        "CA",
        "US"
      ],
      "supports_sms_to_countries": [
        "CA",
        "US"
      ],
      "type": "internal",
      "is_group_number": true,
      "user_id": null,
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "inbound_ring_duration": null,
      "participants": [
        "user_OWiN4rEbBR04K2AKXe3jq5j1JWQqmTguuuZa1dG7qQr",
        "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
        "user_SJMF1fEyZGdtl2RPzCm9zVQ7qhd33VajdGDREhbsxjF"
      ],
      "phone_numbers": [],
      "phone_numbers_formatted": [],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null
    }
  ],
  "has_more": false
}
```

**SDK Code**

```python phone_numbers_list_example
import requests

url = "https://api.close.com/api/v1/phone_number/"

response = requests.get(url, auth=("<CLOSE_API_KEY>", ""))

print(response.json())
```

```javascript phone_numbers_list_example
const url = 'https://api.close.com/api/v1/phone_number/';
const credentials = btoa("<CLOSE_API_KEY>:");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go phone_numbers_list_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.close.com/api/v1/phone_number/"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<CLOSE_API_KEY>", "")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby phone_numbers_list_example
require 'uri'
require 'net/http'

url = URI("https://api.close.com/api/v1/phone_number/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<CLOSE_API_KEY>", "")

response = http.request(request)
puts response.read_body
```

```java phone_numbers_list_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.close.com/api/v1/phone_number/")
  .basicAuth("<CLOSE_API_KEY>", "")
  .asString();
```

```php phone_numbers_list_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.close.com/api/v1/phone_number/', [
  'headers' => [
  ],
    'auth' => ['<CLOSE_API_KEY>', ''],
]);

echo $response->getBody();
```

```csharp phone_numbers_list_example
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.close.com/api/v1/phone_number/");
client.Authenticator = new HttpBasicAuthenticator("<CLOSE_API_KEY>", "");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```