Get Extension (ringcentral_get-extension)
Fetch basic information about a single RingCentral extension (user, call queue, or other extension type) by ID.
Tool Input
idstringrequired— Internal identifier of the extension to fetch (or '~' for the currently authorized extension).(min length: 1)
Tool Output
idinteger— Internal identifier of the extension.
uristring— Canonical URI of the extension.
accountobject— The account this extension belongs to.
idstring— Internal identifier of the account.
uristring— Canonical URI of the account resource.
contactobject— Detailed contact information.
firstNamestring— User's first name (User extension type only).
lastNamestring— User's last name (User extension type only).
namestring— Extension name (User type: concatenation of first + last name).
companystring— User's company name.
jobTitlestring— User's job title.
emailstring— User's contact email.
businessPhonestring— User's contact phone number, E.164 format.
mobilePhonestring— User's mobile (non toll-free) number, E.164 format.
businessAddressobject— User's business address.
countrystring— Country name of the extension user's company.
statestring— State/province name (mandatory for US/UK/Canada).
citystring— City name.
streetstring— Street address.
zipstring— Zip/postal code.
emailAsLoginNameboolean— Whether the contact email is enabled as this user's login name.
pronouncedNameobject— How the user's name is pronounced.
typestring— How the extension user's name is pronounced.(enum: "Default", "TextToSpeech", "Recorded")
textstring— Custom text (for the `TextToSpeech` type only).
promptobject— Custom recorded/TTS name prompt audio.
3 fields
idstring— Internal identifier of the pronounced-name prompt.
contentUristring— Link to the prompt audio resource.
contentTypestring— Content media type of the prompt audio (open string; mirrors the widened get-call-recording contentType).
departmentstring— User's department name.
costCenterobject— Cost center assigned to the extension.
idstring— Internal identifier of the cost center.
namestring— Name of the cost center.
creationTimestring— When the extension was created, ISO 8601 (live-observed, undocumented field).
customFieldsarray— Custom field values on the extension.
[]object
idstring— Internal identifier of the custom field.
valuestring— Value of the custom field.
displayNamestring— Display name of the custom field.
departmentsarray— Department extension(s) this extension belongs to (user extensions, single-extensionId requests only).
[]object
idstring— Internal identifier of the department extension.
uristring— Canonical URI of the department extension resource.
extensionNumberstring— Short number of the department extension.
extensionNumberstring— Extension short number.
extensionNumbersarray— Additional extension numbers assigned to this extension.
[]string
namestring— Extension name.
partnerIdstring— Partner-assigned identifier of the extension.
permissionsobject— Admin/international-calling permissions.
adminobject— Admin permission.
enabledboolean— Whether the Admin permission is enabled.
internationalCallingobject— International Calling permission.
enabledboolean— Whether the International Calling permission is enabled.
profileImageobject— Profile image information.
uristringrequired— Link to the profile image (the only field returned when unset).
etagstring— Identifier of the image.
lastModifiedstring— When the image was last updated, ISO 8601.
contentTypestring— MIME type of the image.
scalesarray— Links to the profile image in different dimensions.
[]object
1 field
uristring— Link to this scaled profile image variant.
referencesarray— Non-RC internal identifiers assigned to the extension.
[]object
refstring— Non-RC identifier of the extension.
typestring— Type of the external identifier.(enum: "PartnerId", "CustomerDirectoryId")
refAccIdstring— Primary federation admin account identifier.
rolesarray— Roles assigned to the extension.
[]object
uristring— Link to the role.
idstring— Internal identifier of the role.
autoAssignedboolean— Whether the role was auto-assigned.
displayNamestring— Display name of the role.
siteCompatibleboolean— Whether the role is site-compatible.
siteRestrictedboolean— Whether the role is site-restricted.
regionalSettingsobject— Regional data (timezone, home country, language) of the extension.
homeCountryobject— The extension's home country.
idstring— Internal identifier of the country.
uristring— Canonical URI of the country resource.
namestring— The official name of the country.
isoCodestring— ISO 3166-1 alpha-2 country code.
callingCodestring— Country calling code (ITU-T E.123/E.164).
timezoneobject— The extension's default timezone.
idstring— Internal identifier of the timezone.
uristring— Canonical URI of the timezone resource.
namestring— Short name of the timezone.
descriptionstring— Meaningful description of the timezone.
biasstring— Timezone UTC offset bias.
languageobject— The extension's regional language.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
greetingLanguageobject— Language used for telephony greetings.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
formattingLocaleobject— Locale used to format numbers, dates, and currencies.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
timeFormatstring— Time format setting; defaults to '12h' when unset.(enum: "12h", "24h")
serviceFeaturesarray— Service features (only present when requesting the caller's own extension).
[]object
enabledboolean— Whether the feature is available for this extension.
featureNamestring— Name of the service feature (open string — the feature catalog may evolve; read-open to avoid whole-response drift).
reasonstring— Reason the feature is limited; returned only when `enabled` is `false`.
setupWizardStatestring— State of the extension's initial configuration wizard.
statusstring— Extension current state.
statusInfoobject— Additional information present when the extension is in 'Disabled' status.
commentstring— Free-form comment describing the status change reason.
reasonstring— Type of suspension/cancellation.(enum: "SuspendedVoluntarily", "SuspendedInvoluntarily", "CancelledVoluntarily", "CancelledInvoluntarily")
tillstring— Date the account will be deleted, ISO 8601 date-time.
typestring— Extension type. Documented values (rc-platform.yml ~L31070–31097): User, FaxUser, FlexibleUser, VirtualUser, DigitalUser, Department, Announcement, Voicemail, SharedLinesGroup, PagingOnly, IvrMenu, ApplicationExtension, ParkLocation, Bot, Room, RoomConnector, Limited, Site, ProxyAdmin, DelegatedLinesGroup, GroupCallPickup. RC also returns undocumented system types (e.g. CompanyExtension) — read as an open string.
subTypestring— Extension subtype, if applicable.(enum: "Unknown", "VideoPro", "VideoProPlus", "DigitalSignage", "Emergency")
callQueueInfoobject— Call Queue extension settings.
slaGoalinteger— Target percentage of calls that must be answered within the SLA threshold.
slaThresholdSecondsinteger— Period, in seconds, considered an acceptable service level.
includeAbandonedCallsboolean— Whether abandoned calls are included in the service-level calculation.
abandonedThresholdSecondsinteger— Calls shorter than this, in seconds, are excluded from the abandoned-calls count.
hiddenboolean— Whether hidden from the company directory.
siteobject— Site the extension belongs to.
idstring— Internal identifier of the site.
uristring— Link to the site resource.
namestring— Name of the site.
codestring— Site code value, if specified.
assignedCountryobject— Country assigned to the extension.
idstring— Internal identifier of the assigned country.
uristring— Canonical URI of the assigned country resource.
isoCodestring— ISO 3166-1 alpha-2 country code.
namestring— Official name of the country.
We're Adding More RingCentral Tools Constantly!
Don't see a specific RingCentral tool you need? Email [email protected] and we can add it.
RingCentral Frequently Asked Questions
What does the Get Extension tool do?
This page documents the Get Extension tool (ringcentral_get-extension). Fetch basic information about a single RingCentral extension (user, call queue, or other extension type) by ID. It is one of the RingCentral Identity tools, invoked through your firm's Weave MCP connection and available to members whose access level permits it.
What is the RingCentral integration?
The RingCentral integration connects your firm's RingCentral account to Weave. RingCentral (RingEX) is a cloud phone/UCaaS platform. This integration exposes read-only call log, call analytics, recordings, directory, extension, and account diagnostics data as governed MCP tools, scoped per member by access level. It groups 17 tools into 5 categories, exposed through your firm's Weave MCP connection and filtered per member by access level.