GuidesClever App DashboardAPI Postman CollectionClever AcademySupportStatus
Guides

API v3 FAQs

FAQs about Clever API v3.0 Migration

1. Will users have new IDs in Clever v3.0?

  • Yes. With v3.0, we introduced the user ID field, which now represents a user’s specific identifier, regardless of their role.

2. What data differences are there between 1.1 and 3.0 (e.g. is there another gender type?)

  • The biggest difference between the two versions is the introduction of a single “users” object instead of separating each user type into individual objects. These users are individually queryable by adding a role type parameter e.g., /users?role=teacher. Find more info here:

3. Will the existing 2.1 API still work if we were to continue to use it and decide to upgrade to 3.0 once we are prepared to do so? If not, what could we expect to be the result if a school were to try and use our application with Clever API 2.1 and our application?

  • You’ll still be able to use API 2.1 which is an alternative to moving to API 3.0. We have some documentation surrounding it here: New in API v2.1. If you’re using contact data, we strongly suggest moving to API 3.0.

4. What are the criteria for creating a user with multiple roles? Does the district SIS have to support multiple roles, or are multiple users in the SIS merged into one Clever user?

  • In order for a user to have multiple roles in Clever, they must first have either a teacher or staff (school admin) account. Those with District Admin accounts can also have a staff or teacher account in Clever.

5. Does the district SIS have to support multiple roles or are multiple users in the SIS merged into one Clever user?

  • The district simply provides data according to the user role. For example, in a district that uses SFTP to sync with Clever, all teachers in the district must be listed in the teachers.csv file. Any user populated in this file will be assigned a teacher account in Clever. If this same user is listed in the staff.csv file with the same email address, they will also have a staff account created for them and it will be associated with the same user ID.

6. What is the upper limit to the number of roles per user, if any?

  • A user can have the roles of teacher, staff, and district admin, but cannot be more than one of any type. It’s important to note that students are limited to that user type.

7. What if I don’t have time to migrate to API 3.0?

Updated 5 months ago