Formatting files for a OneRoster sync
For administrators with Remind Hub using OneRoster format 1.1
A CSV sync can contain up to six OneRoster CSV files. Be sure to include all required fields in your CSVs and include all files in a batched upload (not zipped, .zip, etc.) each time. Your files should always include a full snapshot of active school data; Remind will handle necessary additions, deletions, and updates for recurring syncs.
This article covers the following topics:
How to format your Remind CSV files
Remind is compatible with the OneRoster CSV format and conforms to OneRoster 1.1. Remind does not support the OneRoster API at this time.
There are six required files:
All users must have a unique user ID in the users.csv file. Also, all active classes and schools must have unique IDs in the classes.csv and orgs.csv files.
- All IDs are case-sensitive.
- No quotations in any field.
1. manifest.csv
- The manifest.csv file configures the desired setup. We recommend creating accounts for all roles and all classes. This file is required.
- Download the template here: manifest.csv
2. orgs.csv
- The orgs.csv file provides school information to Remind. This file is required.
- This CSV should include only the paid Remind schools connected to your Remind account that need to be rostered.
- Download template here: orgs.csv
*This field is used to make connections between files (e.g. assigning a student to a school will link a user ID to a school ID). Take care to ensure that all schools have a unique ID.
|
Header Names |
Required Field? |
Notes |
|
sourcedId |
YES* |
The school ID must be unique across the district. Used in the users.csv, classes.csv, and enrollments.csv files to match users, classes, and enrollments to the corresponding school. |
|
name |
YES |
Name of the school. |
|
type |
YES |
Can be “district” or “school”. Please note: Remind will only ingest data from organizations where type = “school.” |
|
parentSourcedId |
NO |
District ID. |
3. users.csv
- The users.csv file provides user account information to Remind. This file should include all admin, student, parent, teacher, and staff users. List non-teaching staff users as "aide" in the file. This file is required.
- An account will be created for every user included in your users.csv file. We strongly recommend excluding emergency contacts from this file as well as any individuals prohibited from contacting students.
- For parent or guardian accounts to be created in Remind, at least one contact point (mobile phone number or email address) is required.
- Download the template here: users.csv
*This field is used to make connections between files. Double check that the sourcedId, orgSourcedIds, and agentSourcedIdids are unique in the file.
|
Header Names |
Required Field? |
Notes |
|
sourcedId |
YES* |
The user ID must be a unique and constant identifier for each user across the district. No user’s ID should match another user’s ID. IDs can include any combination of characters and numbers. Will be used in the demographics.csv and enrollments.csv to match users with their corresponding birthdate and classes. |
|
orgSourcedIds |
YES* |
Must correspond to a school ID provided in the orgs.csv. A user can be in multiple schools. School ID can be in a comma-separated list wrapped in quotes. |
|
agentSourcedIds |
NO* |
Guardian’s sourcedId. Required for student records to link a student to a guardian. This can be a single ID of the related parent or guardian or a comma-separated list wrapped in quotes if the student has more than one parent/guardian. Example: “ID12314,ID2142” |
|
role |
YES |
We ingest the role types of “teacher,” ”student,” “parent,” “guardian,” "aide," and “administrator.” Any user with a “teacher” or “administrator” role who is associated with a class will automatically become a class owner. |
|
|
YES |
User’s email. Required for teachers and administrators. Optional for parents, guardians, and students. |
|
phone |
NO |
Recommended: User’s mobile phone number. Phone numbers can be in most formats, including with/without brackets around the area code, with/without hyphens, and with/without international code. |
|
SMS |
NO |
Recommended: User’s SMS phone number. SMS phone numbers can be in most formats, including with/without brackets around the area code, with/without hyphens, and with/without international code. |
|
preferred_language |
NO |
Recommended: User’s preferred language for messages. The only values we accept for preferred_language and guardian_preferred_language are any two-letter ISO-639-1 or BCP-47 code, or three-letter ISO-639-2 code you can obtain from this list here. |
|
grades |
NO |
Recommended: Student grade level. For students only, enter the student's grade. Permitted grade values are PK, KG, 01 through 12, and Other. Each student can only be associated with one grade. |
|
givenName |
YES |
User’s first name. |
|
familyName |
YES |
User’s last name. |
|
middleName |
NO |
User’s middle name |
|
identifier |
NO |
Recommended: Student number. An optional field for a student ID that the student has access to if different from the student’s sourcedId. If "identifier" is not provided, we will default to using the user's sourcedId as their student-facing ID. |
4. demographics.csv
The demographics.csv file provides student date of birth information to Remind. This file is required to provision student accounts.
Download the template here: demographics.csv
*This field is used to make connections between files. Ensure students have a unique ID in the users.csv file that matches the demographics.csv file.
|
Header Names |
Required Field? |
Notes |
|
sourcedId |
YES* |
Must correspond to a student ID provided in the users.csv files. Must be unique across the school. |
|
birthDate |
YES |
Student date of birth. MM/DD/YYYY or YYYY/MM/DD format. |
5. classes.csv
- The classes.csv file provides class information to Remind. This file is required to create rostered classes.
- Remind classes will be created for every section included in your files. We strongly recommend excluding any classes that should not be created in Remind.
- Title is the class name visible to class owners and participants on Remind. The class names should be unique for each class period or section so that each section is easily identifiable (e.g., English 101 Section 3).
- Download the template here: classes.csv
*This field is used to make connections between files. Ensure classes and schools have a unique ID.
|
Header Names |
Required Field? |
Notes |
|
sourcedId |
YES* |
Class ID must be a unique and constant identifier for each class. Class ID can include any combination of characters and numbers. Must be unique across the district. Will be used in the enrollments.csv file to match an individual class to the corresponding students. |
|
schoolSourcedId |
YES* |
The school ID. Must correspond to a school ID provided in the orgs.csv file. |
|
title |
YES |
Class name. The title should be unique for each class period. |
|
grades |
NO |
If provided, it must be a comma-separated list of grades wrapped in quotes. Example: “11,12” |
6. enrollments.csv
- The enrollments.csv file provides enrollment information to Remind. This file is required to create rostered classes.
- There is a limit of 100 classes per user account.
- For parents or guardians to be enrolled in classes in Remind, they must be connected to a student.
- The role of non-teaching staff members should be listed as "aide" in this file.
- Download template here: enrollments.csv
*This field is used to make connections between files. Ensure classes, students, schools have a unique ID.
|
Header Names |
Required Field? |
Notes |
|
classSourcedId |
YES* |
Must correspond to the class ID provided in the classes.csv file. |
|
userSourcedId |
YES* |
Must correspond to the student sourcedId provided in the users.csv file. If the user has a role type ”teacher” or “administrator,” they will automatically become an owner of the class (resulting in multiple owners if there are multiple teachers in a class). Parents who are connected to students will be enrolled in the same classes as their students. |
|
schoolSourcedId |
YES* |
Must correspond to a school ID provided in the orgs.csv file. |
|
role |
YES |
User’s role. Accepted role types are: “teacher,” ”student,” “parent,” “guardian,” "aide," and “administrator.” |
|
primary |
YES |
True or false (yes or no - case insensitive) is the class owner. Defaults to false (no) if the information is not provided. |
|
sourcedId |
YES |
The enrollment ID. |
Downloadable OneRoster CSV templates
Formatting FAQ
How do I format students with parents?
Add the guardian’s sourcedId to the student’s agentSourcedIds.
In the following example, Red Riding Hood will be linked as a student to the guardian Grandma Hood and Ma Hood in Forest High School (ID: ForestHS):
| orgSourcedIds | sourcedId | givenName | familyName | role | agentSourcedIds | identifier | phone | |
| ForestHS | 32424 | Grandma | Hood | guardian | ||||
| ForestHS | 31111 | Ma | Hood | guardian | 123-123-1234 | cabin@live.com | ||
| ForestHS | 21513 | Red Riding | Hood | student | "32424,31111" | stu513 | wanderer12@gmail.com |