Search Directory Contacts (ringcentral_search-directory-contacts)
Search the RingCentral account's company directory (and any federated accounts) by text, extension type/status, site, department, and sort order. Read-only.
Tool Input
searchStringstring— Text to filter contacts by; matched against firstName, lastName, extensionNumber, phoneNumber, email, jobTitle, department, and customFieldValue.
searchFieldsarray— Restrict `searchString` matching to these fields only.
[]string(enum: "firstName", "lastName", "extensionNumber", "phoneNumber", "email", "jobTitle", "department", "customFieldValue")
showFederatedboolean— If true, include contacts of every account in the federation (each carries its `account` section); if false, only the current account's contacts.
showAdminOnlyContactsboolean— Whether to include AdminOnly contacts. Defaults to false.
extensionTypestring— Restrict results to this single extension type.(enum: "User", "Department", "Announcement", "Voicemail", "SharedLinesGroup", "PagingOnly", "ParkLocation", "IvrMenu", "Limited", "ApplicationExtension", "Site", "Bot", "Room", "DelegatedLinesGroup", "GroupCallPickup", "External")
siteIdstring— Internal identifier of the business site to which extensions belong.
showExternalContactsboolean— Whether to include External (Hybrid) contacts. Defaults to false.
accountIdsarray— Internal identifiers of the accounts to search within.
[]string
departmentstring— Restrict results to this department name.
siteIdsarray— Internal identifiers of the business sites to which extensions belong.
[]string
extensionStatusesarray— Restrict results to extensions in one of these states.
[]string(enum: "Enabled", "Disabled", "NotActivated")
extensionTypesarray— Restrict results to one of these extension types.
[]string(enum: "User", "Department", "Announcement", "Voicemail", "DigitalUser", "VirtualUser", "FaxUser", "PagingOnly", "SharedLinesGroup", "IvrMenu", "ApplicationExtension", "ParkLocation", "Limited", "Bot", "Site", "Room", "ProxyAdmin", "DelegatedLinesGroup", "FlexibleUser", "GroupCallPickup", "RoomConnector")
orderByarray— Sort criteria, applied in `index` priority order.
[]object
indexinteger— Sort priority, starting from 1; optional when only one `orderBy` entry is given.
fieldNamestring— Field to sort by.(enum: "firstName", "lastName", "extensionNumber", "phoneNumber", "email", "jobTitle", "department")
directionstring— Sort direction; defaults to 'Asc'.(enum: "Asc", "Desc")
pageinteger— Which results page to fetch. Omit for page 1.
perPageinteger— Records per page. Omit for the RingCentral default.
Tool Output
pagingobjectrequired— Pagination metadata for `records`.
perPageintegerrequired— Page size — how many items are in each page.
pageinteger— 1-based current page number; omitted if the result is empty.
pageStartinteger— 0-based index of the first element on the current page.
pageEndinteger— 0-based index of the last element on the current page.
totalPagesinteger— Total number of pages in the dataset (may be omitted for performance reasons).
totalElementsinteger— Total number of elements in the dataset (may be omitted for performance reasons).
recordsarrayrequired— Matching directory contacts; empty if none found.
[]object
idstringrequired— Contact extension identifier.
typestring— Contact type (open string — RC directory contact-type taxonomy; may return values beyond the vendored enum).
statusstring— Contact status.(enum: "Enabled", "Disabled", "Frozen", "NotActivated", "Unassigned", "Unknown")
accountobject— The account this contact belongs to.
4 fields
companyNamestring— Company name of the account.
federatedNamestring— Federated (holding) company name, if federated.
idstringrequired— Internal identifier of the account.
mainNumberobject— Account main phone number.
8 fields
formattedPhoneNumberstring— Human-formatted phone number.
phoneNumberstring— Phone number in E.164-like form.
typestring— Phone number type (documented example 'VoiceFax'; open string, not a closed enum).
labelstring— Custom user-assigned name of the phone number, if any.
usageTypestring— Usage type of the phone number.(enum: "MobileNumber", "ContactNumber", "DirectNumber", "ForwardedNumber")
hiddenboolean— Whether the phone number should be hidden.
primaryboolean— Whether this is the primary number (displayed as 'main number', called by default).
smsAvailabilityStatusstring— SMS availability status of the phone number (live-observed, undocumented field).
departmentstring— Department name, when applicable.
emailstring— Contact email address.
extensionNumberstring— Extension short number.
firstNamestring— First name, for user extensions only.
lastNamestring— Last name, for user extensions only.
namestring— Name, for non-user extensions.
jobTitlestring— Job title.
phoneNumbersarray— Phone numbers associated with the contact.
1 field
[]object
8 fields
formattedPhoneNumberstring— Human-formatted phone number.
phoneNumberstring— Phone number in E.164-like form.
typestring— Phone number type (documented example 'VoiceFax'; open string, not a closed enum).
labelstring— Custom user-assigned name of the phone number, if any.
usageTypestring— Usage type of the phone number.(enum: "MobileNumber", "ContactNumber", "DirectNumber", "ForwardedNumber")
hiddenboolean— Whether the phone number should be hidden.
primaryboolean— Whether this is the primary number (displayed as 'main number', called by default).
smsAvailabilityStatusstring— SMS availability status of the phone number (live-observed, undocumented field).
profileImageobject— Contact profile image.
2 fields
etagstring— Identifier of the profile image.
uristring— Link to the profile image resource.
siteobject— Business site the contact belongs to.
3 fields
idstring— Internal identifier of the business site.
namestring— Name of the business site.
codestring— Site code value.
hiddenboolean— Whether the contact is hidden from the directory.
roleobject— Directory role assigned to the contact.
4 fields
idstringrequired— Internal identifier of the directory role.
namestring— Name of the role.
domainstring— Domain the role applies to.
displayNamestring— Display name of the role.
callQueuesarray— Call queues the contact belongs to.
1 field
[]object
2 fields
idstring— Internal identifier of the call queue.
namestring— Name of the call queue.
customFieldsarray— Custom field values on the contact.
1 field
[]object
3 fields
idstring— Internal identifier of the custom field.
namestring— Name of the custom field.
valuestring— Value of the custom field.
groupsarray— Groups the contact belongs to.
1 field
[]object
2 fields
idstring— Internal identifier of the group.
namestring— Name of the group.
costCenterobject— Cost center assigned to the contact.
3 fields
idstring— Internal identifier of the cost center.
codestring— Cost center code.
namestring— Name of the cost center.
integrationobject— External integration information, when applicable.
6 fields
idstring— Internal identifier of the external integration.
typeIdstring— Internal identifier of the integration type.
typestring— Integration type.
displayNamestring— Display name of the integration.
routingTypestring— Routing type used by the integration.
outboundEdgeIdstring— Outbound edge identifier used by the integration.
subTypestring— Contact subtype, when applicable.(enum: "Unknown", "VideoPro", "VideoProPlus", "DigitalSignage", "Emergency")
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 Search Directory Contacts tool do?
This page documents the Search Directory Contacts tool (ringcentral_search-directory-contacts). Search the RingCentral account's company directory (and any federated accounts) by text, extension type/status, site, department, and sort order. Read-only. 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.