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

# Get a phone number

GET https://api.synthflow.ai/v2/numbers/{phone_number_slug}

Retrieves detailed information about a specific phone number.

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

## Authentication

- `Authorization` header (bearer token, required)

## 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

### Path parameters

- `phone_number_slug` (string, required) — The phone number slug (phone number without the leading +).

### Query parameters

- `workspace` (string, required) — Workspace ID.

## Response

### 200

200

- `slug` (string, optional) — The phone number slug (phone number without the leading +).
- `address_requirement` (string, optional) — Address requirement for the phone number.
- `phone_number` (string, optional) — The full phone number in E.164 format.
- `friendly_name` (string, optional) — A human-readable name for the phone number.
- `is_sms_capable` (boolean, optional) — Whether the phone number can send and receive SMS.
- `is_voice_capable` (boolean, optional) — Whether the phone number can make and receive voice calls.
- `iso_country` (string, optional) — ISO country code for the phone number.
- `locality` (string, optional) — The locality or city associated with the phone number.
- `sip_auth_username` (string, optional, nullable) — SIP authentication username, if configured.
- `sip_outbound_proxy` (string, optional, nullable) — SIP outbound proxy, if configured.
- `sip_term_uri` (string, optional) — SIP termination URI.
- `uac_enabled` (boolean, optional) — Whether outbound SIP registration (REGISTER) is enabled for this number.
- `uac_register_expires` (integer, optional, nullable) — SIP registration refresh interval in seconds when registration is enabled.
- `sid` (string, optional) — Phone number SID from the provider.
- `provider_name` (string, optional) — Name of the telephony provider. Common values include `twilio`, `telnyx`, `vonage`, `ring_central`, `ringcx`, `custom`, `zoom`, and `five9`.
- `region` (string, optional) — The region associated with the phone number.
- `is_available` (boolean, optional) — Whether the number is available for inbound assignment.
- `agency_workspace_id` (string, optional, nullable) — Agency workspace ID, if applicable.
- `workspace_id` (string, optional) — The workspace ID the phone number belongs to.
- `created_at` (datetime, optional) — Timestamp when the phone number was created.
- `updated_at` (datetime, optional, nullable) — Timestamp when the phone number was last updated.
- `assistants` (list of string, optional) — List of assistant IDs attached to this phone number.

## Examples

**Response**

```json
{
  "slug": "33782990580",
  "address_requirement": "none",
  "phone_number": "+33782990580",
  "friendly_name": "My Custom Number",
  "is_sms_capable": true,
  "is_voice_capable": true,
  "iso_country": "FR",
  "locality": "Paris",
  "sip_auth_username": null,
  "sip_outbound_proxy": null,
  "sip_term_uri": "sip:33782990580.custom.com",
  "uac_enabled": false,
  "uac_register_expires": null,
  "sid": "PN25f3fa6d8f...b765035605ca",
  "provider_name": "twilio",
  "region": "Ile-de-France",
  "is_available": true,
  "agency_workspace_id": null,
  "workspace_id": "1710107690...5164378100",
  "created_at": {},
  "updated_at": null,
  "assistants": [
    "model_id"
  ]
}
```

**SDK Code**

```python Phone-Numbers_get-phone-number_example
import requests

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

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

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

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

print(response.json())
```

```go Phone-Numbers_get-phone-number_example
package main

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

func main() {

	url := "https://api.synthflow.ai/v2/numbers/33782990580?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-phone-number_example
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/numbers/33782990580?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-phone-number_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

```csharp Phone-Numbers_get-phone-number_example
using RestSharp;

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

```swift Phone-Numbers_get-phone-number_example
import Foundation

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

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