API v3.x FAQs

❗️
Clever Complete Agreement Required
This feature is included with a Clever Complete subscription. Sign up here or email your Application Success Manager to learn more.

Use this page to review common questions about migrating to Clever API v3.x.

Will users have new IDs in Clever v3.0?

Yes. In v3.0, Clever introduced the user ID field, which represents a user’s specific identifier regardless of role.

What data differences are there between v1.1 and v3.0?

One of the biggest changes is the introduction of a single users object instead of separate objects for each user type.

You can query users by role by adding a role parameter such as /users?role=teacher.

For more detail, see:

What are the criteria for creating a user with multiple roles in Clever?

For a user to have multiple roles in Clever, they must first have either a teacher account or a staff (school admin) account. District admins can also have an additional staff or teacher account in Clever.

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

The district provides user data by role.

For example, in a district that uses SFTP to sync with Clever, all teachers must appear in teachers.csv. Any user in that file receives a teacher account in Clever.

If that same user also appears in staff.csv with the same email address, Clever also creates a staff account for that user and associates it with the same user ID.

What is the upper limit to the number of roles per user?

A user can have the roles of teacher, staff, and district admin, but cannot have more than one of the same role type.

Students are limited to the student role.