> 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/import-clients.md).

# Import Clients

**Page type:** Task guide\
**Status:** Draft (Noah Edit)\
**Owner:** Compassly Documentation Team\
**Last verified:** 2026-04-08 (Noah Edit: 2026-05-13)\
**Audience:** Super Admin, Admin, Supervisor

## What This Section Covers

This material covers how to import Client profiles in bulk with the provided template.

## Before You Start

* You must have permission "View client list".
* You must have permission "Import clients".
* If you are not using the import template provided by Compassly, your spreedsheet must match the required format used by Compassly.

## Where To Start

1. Sign in to Compassly.
2. In the left navigation menu, select ***Clients***.

> **Warning:** While it is the default state, you should confirm that you are on the "Active" Client List.

## Available Actions

1. **Download an import template for uploading multiple Client profiles at once.**
   * In the uppermost right corner of the page, click on the button that has a download icon (an arrow pointing down towards what looks like a little tray). This should trigger a small dropdown menu. Select the option "Download import template", and the template should start downloading.

![](/files/XV9tY08xZxt4gEnminEs) ![](/files/ZTCaCn4ETSsckJVFQgkB)\
*Figure 1 - 2. "Active" Client List page with emphasis on download navigation and the success notification for downloading the import template.*

2. **Fill out the import template with all the Client profiles you desire (and what details you can).**
   * Unless you deliberately downloaded your file to a different location, your import template should be available under the Downloads folder on you computer (this guide will not cover phone usage). Open the file and you should see a table with instructional text in the top row, followed by a series of empty rows below it. Using the instructions provided, fill out as many Client profiles as you desire in these empty rows. If the number you are trying to import exceeds the number of rows with grey borders, no worries. You can add beyond the visible boundary point.

> **Warning:** Keep in mind that trying to upload Client profiles with the same *First name*, *Last name*, and *Date of birth* fields as those that already exist in Compassly will result in those Client profiles being omitted from the upload, even if some of the details are different.

![](/files/DbHpQPfMJlKE1VYvQTlC) ![](/files/58UR5bG1rB7Uy8bYTASI) ![](/files/UtKmy7ny1SRl6b7QfrAu) ![](/files/eXNmqF0XYj2iQ43DvaZb)\
*Figure 3 - 6. Example of the import template.*

3. **Upload multiple Client profiles using the import template.**
   * Having filled out the downloaded import template, you can now import the file back into the Program Library. Assuming that you did not close your Compassly tab on your browser (if you did, see "Where To Start" section to return to the appropriate page) return to the "Active" Client List and select the blue "Import clients" button in the uppermost right corner of the page. This will open a dialog box prompting you to select the file for import. Either drag the file into the dash-line box, or click on the dash-line box to open your file explorer and navigate to the desired file. Once selected, the name of the file uploaded should be visible in the dash-line box, and the number of entries validation for import should appear below it. Ensure this number matches what you intended to upload (If not, you'll need to cancel the process, then go back into your import file to fix the issue), and then click the "Upload" button to finalize the import. Notifications will pop in the lower left corner of the page to confirm your results, or inform you of any duplicates that already exist.

![](/files/EiJoaWdaM8ea6082W2R7) ![](/files/ODUoljqafsnfHamZ6JRT)\
*Figure 7 - 8. The dialog box that opens after clicking "Import clients", and the results of selecting a file for upload.*

![](/files/YrXlIcCW3Bo2FlGjtR4R) ![](/files/ccCkxv7HBHwMWKNojLeb)\
*Figure 9 - 10. Notifications you might see after an upload.*

## Notes

* A row passes validation only when:
  * all required fields are present
  * values match the field format rules
  * values meet any field-specific rules
* If *Locations* contains a value that does not already exist in Compassly, that Client is not imported.
* If *Diagnoses* contains a value that does not exist in Compassly, the Client can still be imported, but *Diagnoses* is saved as empty.
* If *Admission date* or *Discharge date* is invalid, or if the date order is incorrect, Compassly imports the Client with that date field empty.
* If *Discharge date* is entered without *Admission date*, Compassly imports the Client with *Discharge date* empty.
* If *Sex*, *Gender identity*, or *Marital status* does not match an allowed value, Compassly imports the Client with that field empty.
* If a field in *Contact person's data*, *Caseworker's data*, and or "Nurse's data\* is filled but the required contact fields are incomplete, Compassly imports the Client with all associated fields empty, including the one you filled out.
* If some rows fail validation, the dialog box shows:
  * the row number
  * the first column where an error was found
* If more than one error exists for a row, Compassly may show the first column name plus a count of additional errors.
* If 0 records passed validation, the "Upload" button is disabled.
* If one or more rows passed validation, "Upload" becomes available.
* If some Clients import successfully and some fail the uniqueness check, Compassly should show a combined result notification:
  * success count for imported clients
  * failure count for duplicate clients
* Imported Clients are not assigned to team members unless those team members use an **All active** Client setting.
* Imported Clients can still be assigned to locations from the import file if the location values already exist in Compassly.

## Role Differences

* ***Super Admin / Admin / Supervisor:*** Will be able to import multiple Client profiles.
* ***Clinician / Basic:*** Does not have access to import multiple Client profiles.

## Summary Of Section

**Upon reviewing this material, you should be able to:**

* Download an upload template for Client profiles
* Fill out an import template for Client profiles
* Upload an import template for Client profiles

## Related Guides

* [View Client List](/compassly-docs/core-modules/clients/view-client-list.md)
* [Add New Client](/compassly-docs/core-modules/clients/add-new-client.md)
* [Edit Client Profile](/compassly-docs/core-modules/clients/edit-client-profile.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/import-clients.md?ask=<question>&goal=<endgoal>
```

`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.
