Skip to main content

Clients

Introduction​

This guide explains how to use the Clients page in My Home Plan to search, view, and manage client records for the selected company.

Accessing the Page​

  1. From the left sidebar, click Clients.
  2. You will be directed to the "Clients" list for the currently selected company.

Navigating the Page​

  • Header/Breadcrumbs: Shows the current location as Clients.
  • Search Bar: A text input labeled “Search by client name, email or phone number” that filters results as you type (debounced by ~500ms).
  • Clear Filters: Button to reset the search query instantly.
  • Loading Indicator: A spinner appears while results are being fetched.
  • Clients Table:
    • Name: Clickable link to the client details page. If agents are linked, their names appear in parentheses (e.g., Agent: John Doe, Jane Roe).
    • Email: Client email address.
    • Phone: Client phone number.
    • Company: Associated company name (if any).
    • Created At: Relative time since creation (e.g., “3 hours ago”).
  • Pagination: Controls at the bottom to move between pages of results.
  • Delete Modal: A confirmation dialog appears when deleting a client, allowing you to confirm or cancel.

Key Features​

  • Company‑Scoped Data: Results are automatically scoped to the currently selected company.
  • Live Search: Type a name, email, or phone number to filter the list (debounced to reduce flicker and unnecessary requests).
  • Deep Links: Click the client’s Name to open their detailed profile.
  • Agent Visibility: If a client is assigned to one or more agents, their names are displayed next to the client’s name.
  • Safe Deletion: Deleting a client requires explicit confirmation via the modal.
  • User Feedback: Inline error banner appears for API errors; a spinner indicates loading.

Common Tasks​

  1. Search for a Client
    • Enter a name, email, or phone in the search bar.
    • Results update automatically after a brief pause.
  2. Clear the Search
    • Click Clear filters to reset the query and reload all clients.
  3. Open a Client Profile
    • Click the Name link to navigate to /clients/{id} for full details.
  4. Delete a Client
    • Trigger the delete action (e.g., from the client row actions in the details page).
    • Confirm in the Delete client modal.
  5. Navigate Pages
    • Use the Pagination controls to move between pages.

Troubleshooting​

  • No Results?
    • Clear the search query and try again.
    • Verify that the correct company is selected.
  • Slow or Stuck Loading?
    • Check your internet connection and retry.
  • Error Banner Appears (red box)
    • The message comes from the API. Try again or contact support if it persists.
  • Cannot Open Client Details?
    • Ensure you have permission and that the client record still exists.

Contact Support​

Reach out via: