Skip to main content

Import participants' pathway progress and authorizations

Add the pathway_code, pathway_authorization_number and other pathway_ columns to the participant import spreadsheet; each row enrolls that participant in the step with that code and creates or links the authorization.

Written by MaryGrace Flores

Pathway progress is imported through the participant import, not a separate file. Add the pathway columns to your participant spreadsheet: a row whose pathway_code matches a step code in your account enrolls the participant in that step. Add a pathway_authorization_number only when you also want to link or create an authorization and record its rate and units. To put one participant on more than one pathway, repeat their row with the same participant details and different pathway values. Build your pathways first, with a code on every step, so the codes exist to match.

Participants are labelled Clients, Students, Residents or Explorers depending on your account type. The import button and the file work the same way for all of them.

Who can do this, and where

  • Web app only, from the participant list.

  • Your role needs the Create permission on the Participants module, or you are an account administrator.

  • Your Equip onboarding contact can run the import for you. Send them the finished file if you would rather not upload it yourself.

  • On an annual contract the import must fit inside your contracted seats.

Before you start

  • Every pathway step you want to enroll people in needs a code on the pathway's page (or in the pathway import file). The import matches on that code and nothing else.

  • Team members named as supporters must already exist in the account under the email you enter.

  • Each participant needs an identifier: an email, or a case_id on community rehabilitation (CRP) accounts. Other account types require an email on every row.

Download the template

Open the participant import template, click File, then Download, then Microsoft Excel (.xlsx). Delete the sample rows, delete any columns you will not use, and rename the file with your organization name. Use the column names below exactly; a column Equip does not recognize stops the upload.

Pathway columns

Column

Required for a pathway row

What Equip does with it

pathway_code

Yes

The code of the step to enroll in. Its pathway is enrolled at the same time. A nonblank code that matches no step in your account blocks validation. Leave it blank for a participant-only row.

pathway_authorization_number

No

The funder's authorization number. Equip reuses an existing authorization with this number for the same participant, otherwise creates one. Without it, pathway progress and the step supporter still import; no authorization or billing line is created.

pathway_start_date

No

Start date of the step. Also becomes the pathway progress's Receive Date if that is empty.

pathway_supporter_email

No

Email of the team member supporting the step. An unknown email leaves the supporter blank; the rest of the row still imports.

pathway_counselor_name

No

Counselor recorded on the authorization.

pathway_authorization_units

No

Units authorized for the step. Blank means 1.

pathway_authorization_rate

No

Rate for the step. Blank means the step's own price.

pathway_authorization_issue_date

No

Authorization issue date.

pathway_authorization_begin_date

No

Authorization begin date.

pathway_authorization_end_date

No

Authorization end date.

Dates can be written as 2026-01-15, 01/15/2026, 01-15-2026, 15/01/2026, 2026/01/15 or 01/15/26. A date Equip cannot read is left blank.

The import does not set step end dates, the Meeting Date, custom date fields, a supporter without a pathway, or closed pathways. Record remaining dates with Update Progress and close the enrollment from View Details. With Pathway Workflows enabled, Task, Form, and Assessment step end dates follow their required work; do not try to enter them in the progress form.

One participant, several pathways

Use one row per pathway step to import. Repeat the same participant details on each row; only the pathway fields may differ. Equip imports the participant once and reuses the progress for the same participant, pathway and case. Multiple step rows for that combination reuse the open pathway round. For a Sequential pathway, import only its first top-level step code and manage later work in Equip.

Steps

  1. In the left sidebar open the participant list and click Import.

  2. Drop your .xlsx file into the panel and click Validate Import.

  3. Review the preview. Each participant shows their identifier and, under Pathways, the codes they will be enrolled in. Rows highlighted in red are participants who already exist in the account.

  4. Choose the toggles: Update Existing Records (on by default) updates matched participants and adds their pathway rows; Send App Invite emails a mobile invitation (not offered on CRP accounts).

  5. Click Import [Participants]. Equip runs the import in the background and notifies you when it finishes.

  6. Open a few participants' Pathways tabs to confirm the enrollments, supporters and authorizations.

Limits and what the errors mean

  • "Missing required headers: name": every file needs a name column.

  • "File must contain either 'email' or 'case_id'/'case_ids' column": add one identifier column.

  • "Row 7: Must have an email address.": on non-CRP accounts every row needs an email.

  • "Invalid headers found: pathway_receive_date, authorization_number": those are not accepted column names. Use the names in the table above.

  • "Row 9: Field 'groups' differs from row 8. When adding multiple pathways for the same participant, only pathway fields should differ.": the repeated rows for one participant do not match. Copy the first row exactly and change only the pathway_ values.

  • "Row 5: Duplicate email 'x' also found in row 3 for a different participant.": two different people share an email. Fix the file.

  • "This import would exceed allocated seats. You have 3 seats left but the import contains 5 unique participants.": annual contracts stop at the contracted seat count. Contact the Equip team for more seats.

  • A nonblank pathway code must match a step in your account. For a Sequential pathway, use its first top-level step code; later steps and child steps are rejected during validation. A blank authorization number does not prevent pathway enrollment. Check the Pathways tab after importing.

  • Repeating the import reuses an open pathway enrollment for the same participant, pathway and case. If the matching enrollment is closed, Equip starts a new enrollment and keeps the closed history. Within an open enrollment, and the same authorization number is linked rather than duplicated. Rate and units are updated unless the step has already been paid.

FAQ

Is there a separate pathway progress import?
No. Pathway progress comes in with the participant import. Add the pathway columns to the participant spreadsheet and upload it from the participant list with Import.

Which columns are required for the pathway part to work?
​pathway_code is required to import pathway progress. pathway_authorization_number is optional and only needed to create or link an authorization. An unknown nonblank code blocks validation; a blank code imports only the participant.

Where do I find the pathway codes?
Open Pathways in the left sidebar, open the pathway, and read each step's code. If a step has no code, add one there before importing, because the import only matches on codes.

Can I put one participant on two pathways?
Yes. Repeat the participant details and change only the pathway values. Equip imports the participant once. Rows for steps in the same pathway and case reuse one pathway progress; a different pathway or case uses a different progress.

What happens if the authorization number already exists?
Equip links the participant's existing authorization with that number instead of creating a new one, and fills in the counselor and dates only where they were blank. Rate and units on the step are updated unless the step is already marked paid.

Can the import set end dates or close pathways?
No. Only start dates, supporters and authorization details are imported. Use Update Progress for Manual step end dates. With Pathway Workflows enabled, complete the required work for Task, Form, and Assessment steps; Form and Assessment steps with Auto Complete off also require staff completion. Close Pathway on View Details closes the enrollment.

I imported and the participants are there but the pathways are missing. Why?
Check that pathway_code was supplied and that Update Existing Records was on for matched participants. Unknown nonblank codes fail validation, and a Sequential pathway must use its first top-level step. An empty authorization number does not prevent enrollment. Correct the file, import again, and verify the participant’s Pathways tab.

Related

  • Fill out the Pathway Import spreadsheet

  • Import participants from a spreadsheet

  • Can a participant run the same pathway more than once?

  • Create a pathway and its steps

  • Record billed and paid dates on an authorization

Did this answer your question?