> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.agentphone.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.agentphone.ai/_mcp/server.

# List Numbers

GET https://api.agentphone.ai/v1/numbers

List the active phone numbers for this account.

Released (deleted) numbers are excluded so the count reflects the numbers
the account actually holds. Fetch a single number via GET /\{number\_id}
(which returns it regardless of status). Pass externalId to find the
number you tagged with your own identifier.

Reference: https://docs.agentphone.ai/api-reference/numbers/list-numbers-v-1-numbers-get

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `offset` (integer, optional, default: 0)
- `externalId` (string, optional, nullable) — Only the number tagged with this externalId

### Headers

- `X-Sub-Account-Id` (string, optional, default: 20) — Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.

## Response

### 200

Successful Response

- `data` (list of PhoneNumberResponse, required)
- `hasMore` (boolean, required)
- `total` (integer, required)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### PhoneNumberResponse

- `id` (string, required)
- `phoneNumber` (string, required)
- `country` (string, required)
- `status` (string, required)
- `createdAt` (datetime, required)
- `type` (string, optional, default: sms)
- `agentId` (string, optional, nullable)
- `outboundSms` (enum, optional, default: enabled)
  - Allowed values: `enabled`, `activating`, `registration_required`
- `inboundCallsEnabled` (boolean, optional, default: true)
- `readReceiptsEnabled` (boolean, optional, default: true)
- `whatsappEnabled` (boolean, optional, default: false)
- `dailyNewContacts` (DailyNewContactsUsage, optional, nullable)
- `externalId` (string, optional, nullable)
- `purchasedAt` (datetime, optional, nullable)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### DailyNewContactsUsage

- `used` (integer, required)
- `limit` (integer, optional, nullable)

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "phoneNumber": "string",
      "country": "string",
      "status": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "type": "sms",
      "agentId": "string",
      "outboundSms": "enabled",
      "inboundCallsEnabled": true,
      "readReceiptsEnabled": true,
      "whatsappEnabled": false,
      "dailyNewContacts": {
        "used": 1,
        "limit": 1
      },
      "externalId": "string",
      "purchasedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "hasMore": true,
  "total": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.agentphone.ai/v1/numbers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.agentphone.ai/v1/numbers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go
package main

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

func main() {

	url := "https://api.agentphone.ai/v1/numbers"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

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

url = URI("https://api.agentphone.ai/v1/numbers")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.get("https://api.agentphone.ai/v1/numbers")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.agentphone.ai/v1/numbers', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.agentphone.ai/v1/numbers");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentphone.ai/v1/numbers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```