Actions55
- Answering Rule Actions
- Analytics Actions
- Call Log Actions
- Call Queue Actions
- Contact Actions
- Extension Actions
- Fax Actions
- Meeting Actions
- IVR Menu Actions
- Message (SMS) Actions
- Presence Actions
- Recording Actions
- RingSense Actions
- Team Messaging Actions
- Webhook Actions
Contact → Search Directory
AI-generatedSummary
Search the RingCentral company directory for contacts matching the provided search text.
Inputs
- searchText (required) — Text used to search the directory (e.g., name, phone number, email).
- authMode — Authentication mode – either use saved credentials ('credentials') or provide a dynamic access token ('dynamic').
- accessToken — OAuth 2.0 access token (only used when authMode is 'dynamic').
- serverUrl — RingCentral API environment (Production or Sandbox) – only used when authMode is 'dynamic'.
- options.showFederated — Whether to include federated contacts in the results (default: true).
- options.extensionType — Filter results by extension type(s) – User, Department, Announcement, Voicemail. If empty, all types are returned.
Output shape
array
Each element is a contact object returned by the RingCentral directory search API, containing fields such as id, firstName, lastName, phoneNumbers, emails, and extension details.
Examples
Example 1: Find all contacts named 'John' in the company directory.
Set Search Text to 'John', leave Options at defaults (Show Federated enabled, no Extension Type filter).