---
title: "Get Phone Numbers"
method: GET
path: "/v2/Account/PhoneNumbers"
tags: ["Account"]
---

# Get Phone Numbers

`GET /v2/Account/PhoneNumbers`

Retrieves all active phone numbers of the account.

## Response `200`

The list of active phone numbers for the account.

- ClientPhoneNumberViewApi[]
  - `id` string, nullable — The unique identifier of the phone number.
  - `number` string, nullable — The phone number in E.164 format.
  - `displayName` string, nullable — The display name of the phone number. Falls back to the raw number when no display name is set.
  - `direction` integer — Phone number direction (supported call capabilities). - InboundOutbound: Supports both inbound and outbound calls. - Inbound: Supports inbound calls only. - Outbound: Supports outbound calls only. - NotSet: Direction is not set. `1 - InboundOutbound` `2 - Inbound` `3 - Outbound` `10 - NotSet`
  - `type` integer — Indicates how the phone number is provisioned and connected to NLPearl. - NLPearlDefault: a shared default number provided by NLPearl. - NLPearl: a number purchased and managed for you by NLPearl. - Twilio: a number from your own Twilio account that you connected. - CustomVoip: a custom VoIP number you connect over SIP. - Undefined: the type could not be determined. `1 - NLPearlDefault` `2 - NLPearl` `3 - Twilio` `4 - CustomVoip` `99 - Undefined`
  - `sipConfig` SIPConfigApiView — Inbound SIP configuration as returned by the API for a custom VoIP number.
    - `domain` string, nullable — The SIP domain to which inbound traffic for this number must be sent (e.g. `{id}-nlpearl-ai.sip.twilio.com`).
    - `isTLS` boolean — Whether inbound SIP traffic uses TLS.
    - `authMethod` SipAuthMethodApiView — Inbound SIP authentication as returned by the API. Passwords are never included.
      - `username` string, nullable — The SIP username accepted for inbound calls.
      - `ips` string[], nullable — Allowlist of source IP addresses authorized to send inbound calls.
  - `sipTrunkConfig` SIPTrunkConfigApiView — Outbound SIP trunk configuration as returned by the API for a custom VoIP number.
    - `sipTrunk` string, nullable — The host of your SIP trunk (IP address or domain) where outbound calls are sent.
    - `edge` string, nullable — The edge/region of the SIP trunk, if set.
    - `isTLS` boolean — Whether outbound SIP traffic uses TLS.
    - `from` string, nullable — The user part of the originating SIP URI (the caller identity presented on outbound calls).
    - `isSipRefer` boolean — Whether call transfers are performed using SIP REFER.
    - `authMethod` SipTrunkAuthMethodApiView — Outbound SIP trunk authentication as returned by the API. Passwords are never included.
      - `username` string, nullable — The SIP username used for outbound calls.
      - `headers` object, nullable — Custom SIP headers added to the outbound INVITE.

## Other responses

- `400` — Error

---

[API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/versions/52d64fc5d6e9/schema)