--- title: "List Extensions" method: GET path: "/restapi/v1.0/account/{accountId}/extension" tags: ["Extensions"] --- # List Extensions `GET /restapi/v1.0/account/{accountId}/extension` Returns the list of extensions created for a particular account. All types of extensions are included in this list. ## Path parameters - `accountId` string, required ## Query parameters - `extensionNumber` string - `email` string - `page` integer - `perPage` integer - `status` string[] - `type` string[] ## Response `200` Extension list information - GetExtensionListResponse - `uri` string, uri — Link to an extension list resource - `records` GetExtensionListInfoResponse[], required — List of extensions with extension information - `id` integer — Internal identifier of an extension - `uri` string, uri — Canonical URI of an extension - `contact` ContactInfo — Detailed contact information - `firstName` string — User's first name (for extensions of `User` type only) - `lastName` string — For User extension type only. User's last name (for extensions of `User` type only) - `name` string — Extension name (for extensions of `User` type - concatenation of first and last name) - `company` string — User's company name - `jobTitle` string — User's job title - `email` string, email — User's contact email - `businessPhone` string — User's contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format - `mobilePhone` string — User's mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format - `businessAddress` ContactBusinessAddressInfo — User's business address. The default is Company (Auto-Receptionist) settings - `country` string — Country name of a user's company - `state` string — State/province name of a user's company. Mandatory for the USA, UK and Canada - `city` string — City name of a user's company - `street` string — Street address of a user's company - `zip` string — Zip code of a user's company - `emailAsLoginName` boolean — Indicates that the contact email is enabled as a login name for this user. Please note that the email must be unique in this case. - `pronouncedName` PronouncedNameInfo - `type` 'Default' | 'TextToSpeech' | 'Recorded' — The method used to pronounce the user's name: - `Default` - default extension name; first and last name specified in user's profile are pronounced using text-to-speech; - `TextToSpeech` - custom text specified by a user pronounced using text-to-speech; - `Recorded` - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval). - `text` string — Custom text (for `TextToSpeech` type only) - `prompt` PronouncedNamePromptInfo - `id` string - `contentUri` string, uri — Link to a prompt resource - `contentType` 'audio/mpeg' | 'audio/wav' — Content media type - `department` string — User's department name - `extensionNumber` string — Extension short number - `name` string — Extension name. For user extension types the value is a combination of the specified first name and last name - `permissions` ExtensionPermissions — Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling' - `admin` PermissionInfoAdmin — Admin permission - `enabled` boolean — Specifies if a permission is enabled or not - `internationalCalling` PermissionInfoInt — International Calling permission - `enabled` boolean — Specifies if a permission is enabled or not - `profileImage` ProfileImageInfo — Information on profile image - `uri` string, uri, required — Link to a profile image. If an image is not uploaded for an extension, only `uri` is returned - `etag` string — Identifier of an image - `lastModified` string, date-time — Date/time when an image was last updated, in ISO 8601 format, for example 2016-03-10T18:07:52.534Z - `contentType` string — The type of image - `scales` ProfileImageInfoURI[] — List of URIs to profile images in different dimensions - `uri` string, uri - `status` 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned' — Extension current state. If 'Unassigned' is specified, then extensions without `extensionNumber` are returned. If not specified, then all extensions are returned - `type` 'User' | 'FaxUser' | 'FlexibleUser' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ApplicationExtension' | 'ParkLocation' | 'Bot' | 'Room' | 'Limited' | 'Site' | 'ProxyAdmin' | 'DelegatedLinesGroup' | 'GroupCallPickup' — Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology - `subType` 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency' — Extension subtype, if applicable. For any unsupported subtypes the `Unknown` value will be returned - `callQueueInfo` CallQueueExtensionInfo — For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology - `slaGoal` integer — Target percentage of calls that must be answered by agents within the service level time threshold - `slaThresholdSeconds` integer — Period of time in seconds that is considered to be an acceptable service level - `includeAbandonedCalls` boolean — If `true` abandoned calls (hanged up prior to being served) are included into service level calculation - `abandonedThresholdSeconds` integer — Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation - `hidden` boolean — Hides extension from showing in company directory. Supported for extensions of User type only - `site` ProvisioningSiteInfo — Site data. If multi-site feature is turned on for an account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) the site ID should be set to `main-site` - `id` string, uri — Internal identifier of a site - `uri` string, uri — Link to a site resource - `name` string — Name of a site - `code` string — Site code value. Returned only if specified - `assignedCountry` AssignedCountryInfo — Information on a country assigned to an extension user. Returned for the User extension type only - `id` string — Internal identifier of an assigned country - `uri` string — Canonical URI of an assigned country resource - `isoCode` string — Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) - `name` string — Official name of a country - `costCenter` CostCenterInfo — Cost center information. Applicable if Cost Center feature is enabled. The default is `root` cost center value - `id` string — Internal identifier of a cost center - `name` string — Name of a cost center - `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)