> For the complete documentation index, see [llms.txt](https://compassly.gitbook.io/compassly-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://compassly.gitbook.io/compassly-docs/core-modules/clients/view-client-list.md). # View Client List **Page type:** Task guide\ **Status:** Draft (Nah Edit)\ **Owner:** Compassly Documentation Team\ **Last verified:** 2026-04-08 (Noah Edit: 2026-05-11)\ **Audience:** Super Admin, Admin, Supervisor, Clinician, Basic ## What This Section Covers This material covers how to open the Client List and review the items available to your role. ## Before You Start * You must have permission "View client list". * Understand that the list view may look slightly different depending on your role or permissions. ## Where To Start 1. Sign in to Compassly. 2. In the left navigation menu, select ***Clients***. ## Available Actions 1. **Open the *****"Clients"***** page from the left navigation.** * (These steps are covered in the "Where To Start" segment as seen above) 2. **Review the list of Clients using page controls.** * You can use the scrollwheel of your computer mouse while hovering over the list or the grey side scroll bar available on the right of the screen to move the list up and down. * In the top right corner of the page above the list, there will be pagination controls (see image below). Use the arrows to navigate back one page (left arrow) or forward one page (right arrow). Select a number to navigate to a specific page (i.e select "5" to navigate to the fifth page of entries). Finally, you can use the small dropdown box found to the right of the pagination controls to alter how many entries are visible per page (50 equals fifty entries per page, 150 means 150 entries per page, etc). 3. **Use the filters to refine the list data when needed.** * Use the column filter to sort column specific information. "Sort A to Z" can sort list items alphabetically/reverse alphabetically. Below that, we have a text box to search for a list item by name (This will also filter the available set options below). Below the text box, we have "set" options. By selecting the check box next to a set option, you will limit the list to display only that option. You can select multiple set options at once to display as many as you desire. if you do select a set option, you can de-select it by unchecking the box, hitting the "Clear all" button that will appear at the bottom of the Column Filter display, or hitting the "x" button on the filter notifier that will appear above the list after you select a set option (Navigating away from the page will clear all filters as well). * Use the search bar located in the top left corner above the list to search the entire table for the desired text. * Use the Table Filter located in the uppermost right corner of the page to hide entire columns of data in the list. Upon clicking the icon, a small dropdown menu should appear containing the names of all the column headers in the list. Select an empty checkbox to display a column, and de-select a checkbox to hide a column. * Use the *Select team members* dropdown in the upper right hand corner of the page to filter the list by the team members assigned to Clients. Simply select one of the options listed in the dropdown to filter Clients based on that option, which should create a small blue checkmark to the right of that option. You can select multiple team members for your filtering. If you would like to remove a team member selection from your filtering, simply select the option again to remove the team member's name from the search parameters. You can also use the "Clear all" button located at the bottom of the dropdown menu, select the "x" button next to a team member option located in *Select team members* bar itself, or use the "x" button located to the far right of the *Select team members* bar to clear all team member search parameters. If you are looking for a particular team member to use for your filtering, you can use the built in search bar in the dropdown menu to filter your options by text. If "All team members" is selected, all other team member selections are reset. 4. **Switch between the Active and Inactive Client List.** * Below the "All clients" title of the page, to the right of the "Clients /" breadcrumb, there is another dropdown menu that will be set to "Active" as a default. Click on "Active" to open the dropdown menu, where you can then select the options to switch between the "Active" and "Inactive" status of the Clients you are viewing. Certain options, such as activating or deactivating a Client, will only be available to you depending on the *Active* status you are viewing. * If you open a Client's profile/records and return by breadcrumb, back navigation, or use of the "Cancel" button, Compassly keeps you on the same Client List you came from. ![](/files/bgD5ZnRlPhVUAu66oSyq)\ *Figure 2: A general view of the "Active" Client List and it's filters. The \* symbol marks the Select team members field.* ## Notes * "Add new client", "Download import template", and "Import clients" actions are available only under the "Active" Client List. * The table is sorted by Client name by default. * Long values may be shortened with "..." in the table. * Selecting email addresses in the table will cause the browser to open a new window prompting you to select an email handler, or navigation you to an an established email handler to being creating a new email to the correspondance you selected. ## Role Differences * ***Super Admin / Admin / Supervisor / Clinician / Basic:*** Will be able to view the Client List. ## Summary Of Section **Upon reviewing this material, you should be able to:** * Navigate to the Client List via the left-hand side navigation menu * Apply filters to the list to refine your search * Scroll through and navigate through different pages of the list * Switch between the "Active" and "Inactive" Client List. ## Related Guides * [Add New Client](/compassly-docs/core-modules/clients/add-new-client.md) * [Edit Client Profile](/compassly-docs/core-modules/clients/edit-client-profile.md) * [Import Clients](/compassly-docs/core-modules/clients/import-clients.md) * [Deactivate Client](/compassly-docs/core-modules/clients/deactivate-client.md) * [Activate Client](/compassly-docs/core-modules/clients/activate-client.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://compassly.gitbook.io/compassly-docs/core-modules/clients/view-client-list.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.