---
title: "Get Extension Phone Number List"
method: GET
path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number"
tags: ["Phone Numbers"]
---

# Get Extension Phone Number List

`GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number`

Returns the list of phone numbers that are used by a particular extension,
can be filtered by the phone number type. The returned list contains all
numbers which are directly mapped to the given extension. Plus the features
and company-level numbers that may be used when performing different operations
on behalf of this extension.

## Path parameters

- `accountId` string, required
- `extensionId` string, required

## Query parameters

- `status` 'Normal' | 'Pending' | 'PortedIn' | 'Temporary'
- `usageType` string[]
- `page` integer
- `perPage` integer

## Response `200`

OK: User Phone Number List

- GetExtensionPhoneNumbersResponse
  - `uri` string, uri — Link to the user phone number list resource
  - `records` UserPhoneNumberInfo[], required — List of phone numbers
    - `uri` string, uri — Link to the user phone number resource
    - `id` integer — Internal identifier of a phone number
    - `country` CountryInfoBasicModel
      - `id` string — Internal identifier of a country
      - `uri` string, uri — Canonical URI of a country resource
      - `name` string — The official name of a country
    - `contactCenterProvider` ContactCenterProvider — CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'
      - `id` string — Internal identifier of the provider
      - `name` string — Provider's name
    - `extension` UserPhoneNumberExtensionInfo — Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list
      - `id` integer — Internal identifier of an extension
      - `uri` string, uri — Canonical URI of an extension
      - `extensionNumber` string — Extension short number
      - `partnerId` string — For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using `pid=XXX` clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension
      - `type` 'User' | 'FaxUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Site' — Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology
      - `contactCenterProvider` ContactCenterProvider — CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'
        - `id` string — Internal identifier of the provider
        - `name` string — Provider's name
      - `name` string — Extension name. For user extension types the value is a combination of the specified first name and last name
    - `label` string — Custom user-defined name of a phone number, if any
    - `location` string — Location (City, State). Filled for local US numbers
    - `paymentType` 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree' — Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
    - `phoneNumber` string — Phone number
    - `primary` boolean — Indicates if a phone number is primary, i.e. displayed as 'main number' and called by default
    - `status` 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' — Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
    - `type` 'VoiceFax' | 'FaxOnly' | 'VoiceOnly' — Phone number type
    - `subType` 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency' — Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned
    - `usageType` 'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'NumberPool' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber' — Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests
    - `features` string[] — List of features of a phone number
  - `navigation` PageNavigationModel, required — Links to other pages of the current result set
    - `firstPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `nextPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `previousPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
    - `lastPage` PageNavigationUri
      - `uri` string, uri — Canonical URI to retrieve the particular page of the result set
  - `paging` EnumeratedPagingModel, required
    - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request.
    - `page` integer — The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
    - `pageStart` integer — The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
    - `pageEnd` integer — The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
    - `totalPages` integer — The total number of pages in a dataset. May be omitted for some resources due to performance reasons
    - `totalElements` integer — The total number of elements in a dataset. May be omitted for some resource due to performance reasons

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)