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

# List Company Phone Numbers

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

Returns the list of phone numbers assigned to RingCentral customer
account. Both company-level and extension-level numbers are returned.

## Path parameters

- `accountId` string, required

## Query parameters

- `page` integer
- `perPage` integer
- `usageType` string[]
- `paymentType` 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree' — Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
- `status` 'Normal' | 'Pending' | 'PortedIn' | 'Temporary'

## Response `200`

Success

- AccountPhoneNumbers
  - `uri` string, uri — Link to a list of account phone numbers
  - `records` CompanyPhoneNumberInfo[] — List of account phone numbers
    - `uri` string, uri — Link to a company 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
    - `extension` ExtensionInfo — 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
      - `name` string — Extension name
      - `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
    - `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
    - `status` 'Normal' | 'Pending' | 'PortedIn' | 'Temporary' — Status of a phone number. If the value is 'Normal', the phone number is ready to be used. If the value is 'Pending' it is an external number not yet ported to RingCentral.
    - `type` 'VoiceFax' | 'FaxOnly' | 'VoiceOnly' — Phone number type
    - `usageType` 'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'NumberPool' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber' — Usage type of phone number. Usage type of phone number. Numbers of 'NumberPool' type are not returned in phone number list requests
    - `temporaryNumber` TemporaryNumberInfo — Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only
      - `id` string — Temporary phone number identifier
      - `phoneNumber` string — Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format
    - `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
    - `vanityPattern` string — Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters `nxx` plus `line` or `numberPattern`
    - `primary` boolean — Specifies if a phone number is primary, i.e. displayed as 'main number' and called by default
  - `navigation` PageNavigationModel — 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
    - `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)