> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# List phone numbers

GET https://api.synthflow.ai/v2/numbers

Lists all phone numbers assigned to a workspace.

Reference: https://docs.synthflow.ai/api-reference/platform-api/phone-numbers/get-numbers

## Authentication

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

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Query parameters

- `workspace` (string, required) — Workspace ID.
- `limit` (integer, optional, default: 20) — Phone numbers displayed per page.
- `offset` (integer, optional, default: 0) — Index of the first phone number to be returned.
- `is_available` (boolean, optional) — Filters phone numbers by inbound availability. - `true`: only numbers not assigned to inbound agents - `false`: only numbers assigned to inbound agents

## Response

### 200

200

- `status` (string, optional) — Whether the request was successful.
- `response` (NumbersGetResponsesContentApplicationJsonSchemaResponse, optional)

## Errors

### 400 Bad Request Error

400

## Types

### NumbersGetResponsesContentApplicationJsonSchemaResponse

- `pagination` (NumbersGetResponsesContentApplicationJsonSchemaResponsePagination, optional)
- `phone_numbers` (list of NumbersGetResponsesContentApplicationJsonSchemaResponsePhoneNumbersItems, optional)

### NumbersGetResponsesContentApplicationJsonSchemaResponsePagination

- `total_records` (integer, optional) — Total number of phone numbers.
- `limit` (integer, optional) — Number of phone numbers per page.
- `offset` (integer, optional) — Index of the first phone number returned.

### NumbersGetResponsesContentApplicationJsonSchemaResponsePhoneNumbersItems

- `number` (string, optional) — Phone number.
- `sid` (string, optional, nullable) — Phone number SID. May be null for custom numbers.
- `is_available` (boolean, optional) — Whether the number is available for inbound assignment.

## Examples

**Response**

```json
{
  "status": "ok",
  "response": {
    "pagination": {
      "total_records": 38,
      "limit": 20,
      "offset": 0
    },
    "phone_numbers": [
      {
        "number": "+17166663572",
        "sid": "PN25f3fa6d...035605ca",
        "is_available": true
      },
      {
        "number": "+17166663442",
        "sid": null,
        "is_available": false
      }
    ]
  }
}
```

**SDK Code**

```python Phone-Numbers_get-numbers_example
import requests

url = "https://api.synthflow.ai/v2/numbers"

querystring = {"workspace":"1710107690998x536152705164378100"}

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

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

print(response.json())
```

```go Phone-Numbers_get-numbers_example
package main

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

func main() {

	url := "https://api.synthflow.ai/v2/numbers?workspace=1710107690998x536152705164378100"

	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 Phone-Numbers_get-numbers_example
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/numbers?workspace=1710107690998x536152705164378100")

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 Phone-Numbers_get-numbers_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.synthflow.ai/v2/numbers?workspace=1710107690998x536152705164378100")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```csharp Phone-Numbers_get-numbers_example
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/numbers?workspace=1710107690998x536152705164378100");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Phone-Numbers_get-numbers_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/numbers?workspace=1710107690998x536152705164378100")! 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()
```