Search the directory API
Use GET with q and optional limit; default limit is 20.
Exact navigationxConnect browser softphone → authenticated API
Before you begin
- Confirm the module is active and use the exact navigation shown above.
- Use an account with the stated module and core CRM permissions.
- Use known test records when changing statuses, visibility, saved filters or global navigation.
What this guide covers
Use GET with q and optional limit; default limit is 20. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.
Exact step-by-step process
- Open xConnect browser softphone → authenticated API.
- Locate the record, setting or action used to search the directory api.
- Complete the displayed fields or controls exactly as described in this guide.
- Select the available save, submit, update, call, sign, upload or confirm action.
- Return to the related register, portal, dashboard or call panel and verify the recorded result.
Fields, choices and supported possibilities
API operationUse GET with q and optional limit; default limit is 20.
Code-backed validations and workflow rules
- Responses use JSON and no-store security headers.
- Do not expose session credentials or CSRF values in logs.
Expected result and verification
- The search the directory api workflow completes without a validation, permission or availability error.
- The relevant case, document, proposal, call, extension, widget session, timeline or audit evidence shows the expected state.
- Any client-visible or public result appears only where the code explicitly allows it.
Security, privacy and operational checks
- Use a controlled test case, contact, extension or website origin before production rollout.
- Grant the minimum permissions needed and protect private documents, call metadata, signing evidence, API credentials and infrastructure paths.