CYPHER Learning
Learning management system integration and automation
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{instance-url}/api/v3 | link | — | — | — |
Actions (115)
Groups · 19
- Add admins to groupGET /api/add_admins_to_group
Add admins to a group.
documented - Add groupGET /api/add_group
Create a new group.
documented - Add members to groupGET /api/add_members_to_group
Add users to a group as members.
documented - Create groupPOST /groups
Create a new group.
documented - Delete groupDELETE /groups/{group_id}
Delete a group.
documented - Delete groupsGET /api/delete_groups
Delete specified groups.
documented - Edit groupGET /api/edit_group
Update an existing group's attributes.
documented - Get groupGET /groups/{group_id}
Load a single group's details.
documented - Get groups by IDsGET /api/get_groups_with_ids
Return info for specified groups.
documented - List group adminsGET /api/get_admins_for_group
Return the admins of a group.
documented - List group membersGET /api/get_members_for_group
Return the members of a group.
documented - List groupsGET /api/get_all_groups
Return info about all groups in the caller's business.
documented - List groupsGET /groups
Return a list of groups.
documented - List groups for adminGET /api/get_groups_with_admin
Return groups that a user is an admin of.
documented - List groups for memberGET /api/get_groups_with_member
Return groups that a user is a member of.
documented - Remove admins from groupGET /api/remove_admins_from_group
Remove admins from a group.
documented - Remove members from groupGET /api/remove_members_from_group
Remove users from a group.
documented - Search groupsGET /api/get_groups_that_match
Return groups matching provided constraints.
documented - Update groupPATCH /groups/{group_id}
Update a group's details.
documented
Users · 17
- Add userGET /api/add_user
Create a new user with supplied attributes (or update if a match is found).
documented - Archive usersGET /api/archive_users
Archive specified users.
documented - Create userPOST /users
Create a new user.
documented - Create userPOST /users
Create a new user.
documented - Delete userDELETE /users/{user_id}
Delete a user.
documented - Delete userDELETE /users/{user_id}
Delete a user.
documented - Delete usersGET /api/delete_users
Delete specified users.
documented - Get my accountGET /api/get_my_account
Return information about the caller's own account.
documented - Get userGET /users/{user_id}
Load a single user's details.
documented - Get userGET /users/{user_id}
Load a single user's details.
documented - Get users by IDsGET /api/get_users_with_ids
Return info for the specified users by their IDs.
documented - List usersGET /users
Return a list of users.
documented - List usersGET /api/get_all_users
Return info about all users in the caller's school. Paginated via page.
documented - Reactivate usersGET /api/reactivate_users
Reactivate previously archived users.
documented - Search usersGET /api/get_users_that_match
Return users matching provided constraints (attributes).
documented - Update userGET /api/update_user
Update an existing user's attributes.
documented - Update userPATCH /users/{user_id}
Update an existing user's details.
documented
Curricula · 15
- Create curriculumPOST /curricula
Create a new curriculum.
documented - Create curriculumPOST /curricula
Create a new curriculum.
documented - Delete curriculumDELETE /curricula/{curriculum_id}
Delete a curriculum.
documented - Delete curriculumDELETE /curricula/{curriculum_id}
Delete a curriculum.
documented - Get curricula by IDsGET /api/get_curricula_with_ids
Return info for specified curricula.
documented - Get curricula for classGET /api/get_curricula_for_class
Return curricula associated with a class.
documented - Get curricula for groupGET /api/get_curricula_for_group
Return curricula associated with a group.
documented - Get curricula for job titleGET /api/get_curricula_for_job_title
Return curricula associated with a job title.
documented - Get curriculumGET /curricula/{curriculum_id}
Load a curriculum.
documented - Get curriculumGET /curricula/{curriculum_id}
Load a curriculum.
documented - Get proficiencies for curriculumGET /api/get_proficiencies_for_curriculum
Return proficiencies for a curriculum.
documented - List curriculaGET /api/get_all_curricula
Return info about all curricula/competencies.
documented - List curriculaGET /curricula
Return curricula/competencies.
documented - Update curriculumPATCH /curricula/{curriculum_id}
Update a curriculum.
documented - Update curriculumPATCH /curricula/{curriculum_id}
Update a curriculum.
documented
Job Titles · 15
- Add job titleGET /api/add_job_title
Create a new job title.
documented - Create job titlePOST /job_titles
Create a new job title.
documented - Create job titlePOST /job_titles
Create a new job title.
documented - Delete job titleDELETE /job_titles/{job_title_id}
Delete a job title.
documented - Delete job titleDELETE /job_titles/{job_title_id}
Delete a job title.
documented - Delete job titlesGET /api/delete_job_titles
Delete specified job titles.
documented - Edit job titleGET /api/edit_job_title
Update a job title.
documented - Get job titleGET /job_titles/{job_title_id}
Load a job title.
documented - Get job titleGET /job_titles/{job_title_id}
Load a job title.
documented - Get job titles by IDsGET /api/get_job_titles_with_ids
Return info for specified job titles.
documented - List job titlesGET /api/get_all_job_titles
Return info for all job titles.
documented - List job titlesGET /job_titles
Return job titles.
documented - Search job titlesGET /api/get_job_titles_that_match
Return job titles matching constraints.
documented - Update job titlePATCH /job_titles/{job_title_id}
Update a job title.
documented - Update job titlePATCH /job_titles/{job_title_id}
Update a job title.
documented
Courses · 13
- Add learners to coursePOST /courses/{course_id}/learners
Enroll learners in a course.
documented - Add learners to coursePOST /courses/{course_id}/learners
Enroll learners in a course.
documented - Create coursePOST /courses
Create a new course.
documented - Delete courseDELETE /courses/{course_id}
Delete a course.
documented - Delete courseDELETE /courses/{course_id}
Delete a course.
documented - Get course detailsGET /courses/{course_id}
Load details for a specific course.
documented - List coursesGET /courses
Return a list of all courses.
documented - List learners in courseGET /courses/{course_id}/learners
List learners enrolled in a course.
documented - List learners in course (enrollment)GET /courses/{course_id}/learners
List learners enrolled in a course.
documented - List teachers in courseGET /courses/{course_id}/teachers
List teachers for a course.
documented - List teachers in courseGET /courses/{course_id}/teachers
List teachers for a course.
documented - Update coursePATCH /courses/{course_id}
Update course details.
documented - Update coursePATCH /courses/{course_id}
Update course details.
documented
Certificates · 11
- Create certificatePOST /certificates
Create a new certificate.
documented - Create certificatePOST /certificates
Create a new certificate.
documented - Delete certificateDELETE /certificates/{certificate_id}
Delete a certificate.
documented - Delete certificateDELETE /certificates/{certificate_id}
Delete a certificate.
documented - Get certificateGET /certificates/{certificate_id}
Load a certificate.
documented - Get certificateGET /certificates/{certificate_id}
Load a certificate.
documented - Get certificates by IDsGET /api/get_certificates_with_ids
Return info for specified certificates.
documented - List certificatesGET /api/get_all_certificates
Return info about all certificates in libraries.
documented - List certificatesGET /certificates
List certificates.
documented - Update certificatePATCH /certificates/{certificate_id}
Update a certificate.
documented - Update certificatePATCH /certificates/{certificate_id}
Update a certificate.
documented
Organizations · 10
- Add organizationGET /api/add_organization
Create a new organization.
documented - Create organizationPOST /organizations
Create a new organization.
documented - Delete organizationDELETE /organizations/{organization_id}
Delete an organization.
documented - Delete organizationsGET /api/delete_organizations
Delete specified organizations.
documented - Edit organizationGET /api/edit_organization
Update an existing organization's attributes.
documented - Get organizationGET /organizations/{organization_id}
Load a single organization's details.
documented - Get organizations by IDsGET /api/get_organizations_with_ids
Return info for specified organizations.
documented - List organizationsGET /organizations
Return a list of organizations.
documented - List organizationsGET /api/get_all_organizations
Return info about all organizations in the caller's business.
documented - Update organizationPATCH /organizations/{organization_id}
Update an organization's details.
documented
Classes · 4
- Get status of classesGET /api/get_status_of_classes
Return status groupings (enrolled, deactivated, completed) for a user.
documented - List class completionsGET /api/get_all_class_completions
Return info about students who completed classes.
documented - List students for classGET /api/get_students_for_class
Return student info for a class.
documented - List teachers for classGET /api/get_teachers_for_class
Return teacher info for a class.
documented
Grades · 3
- List grades for classGET /api/get_grades_for_class
Return grade information for all users in a class.
documented - List grades for userGET /api/get_grades_for_user
Return grade information for a user across classes.
documented - Set grades for assignmentGET /api/set_grades_for_assignment
Set grades for specified users for an assignment.
documented