iQualify Management API
The iQualify API offers management responses for building learning experiences using your iQualify instance data. Once you’ve registered with iQualify, you…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The iQualify API offers management responses for building
learning experiences using your iQualify instance data.
Once you’ve registered with iQualify, you can request an API access token by
navigating to the API access section of the "Account Settings" area.
Find out how to Request your API access token
on our Knowledge base.
All endpoints are only accessible via https and are located at
api.iqualify.com. For instance: you can find your current offerings by
accessing the following URL:
https://api.iqualify.com/v1/offerings/current
Endpoints 84
API info
- GETList supported endpoints URLs
/Responds with all supported endpoints URLs for v2 version.
Course mappings
- GETFind course mappings
/course-mappingsReturns all course mappings for course offerings. - GETFind course mappings by externalCourseId
/course-mappings/externalcourse/:externalCourseIdResponds with course mapping details by externalCourseId. - GETFind course mappings by offeringId
/course-mappings/:offeringIdResponds with course mapping details by offeringId. - PUTAdd course mapping
/course-mappings/:offeringId/:externalCourseIdCreates a mapping between the offering and the externalCourseId. - DELETERemove course mapping
/course-mappings/:offeringId/:externalCourseIdRemoves the course mapping between the offering and the externalCourseId.
Courses
- GETFind courses
/coursesResponds with all courses (draft and published.) - GETFind course by contentId
/courses/:contentIdResponds with a course matching the contentId. - GETFind activations for a contentId
/courses/:contentId/activationsResponds with all activations for the contentId provided. - GETFind users who have access to the contentId provided
/courses/:contentId/permissionsResponds with users who have access to a specific course by contentId. - POSTUpdate course access
/courses/:rootContentId/permissions/:userEmailProvide a user with access to a specific course by rootContentId.
Course metadata
- PUTUpdate course category
/courses/:contentId/metadata/categoryAdd or update course category in the metadata of a course. - PUTUpdate course level
/courses/:contentId/metadata/levelAdd or update the course level in the metadata of a course. - PUTUpdate course tags
/courses/:contentId/metadata/tagsAdd or update course tags in the metadata of a course. - PUTUpdate course topic
/courses/:contentId/metadata/topicAdd or update the course topic in the metadata of a course.
Offerings
- GETFind current, past and future offerings
/offeringsResponds with all offerings for your organisation. - POSTCreate offering
/offeringsCreates a new offering. - GETFind active offerings
/offerings/currentResponds with active offerings for your organisation. - GETFind scheduled offerings
/offerings/futureResponds with scheduled offerings for your organisation. Scheduled offerings have a start date after today's date (inclusive). - GETFind offerings where info field matches the specified textPattern
/offerings/info/:textPatternFind offerings where info field matches the specified text pattern. - GETFind past offerings
/offerings/pastResponds with past offerings for your organisation. - GETOfferings summary
/offerings/summary?$top=50&$orderby=string&$filter=stringResponds with a summary of all offerings for your organisation. - GETFind offering by ID
/offerings/:offeringIdResponds with an offering matching the offeringId. - PATCHUpdate offering
/offerings/:offeringIdUpdates the offering.
Assessment management
- GETFind offering's activities
/offerings/:offeringId/activities/openresponseResponds with the activities in a specific offering. - GETFind offering's assessments
/offerings/:offeringId/assessmentsResponds with all assessments in an offering matching the offeringId. - PATCHUpdate assessment details
/offerings/:offeringId/assessments/:assessmentIdUpdates the assessment details for a specified assessment in an offering. - DELETERemove assessment document
/offerings/:offeringId/assessments/:assessmentId/documents/:documentIdRemoves the assessment document file for a specified assessment in an offering. - PATCHUpdate the due dates for a learner's quiz attempt
/offerings/:offeringId/assessments/:assessmentId/:userEmailUpdates the due dates for a learner's quiz attempt specified by the assessmentId. - GETFind learners with assessments pending x days before due date within the specified offeringId
/offerings/:offeringId/learners/pending-submission?days=stringResponds with learners who have one or more assessments due x days before the due date, with each assessment that is due, where x = the number of days… - DELETEReset user's assessment to draft state
/offerings/:offeringId/users/:userEmail/assessments/:assessmentIdResets the user's submitted assessment to a draft state. - GETFind learner's open response assessment submissions
/offerings/:offeringId/users/:userEmail/submissions/open-responseResponds with open response assessment submissions by a learner in an offering.
Assessment data
- GETFind open response activity attempts
/offerings/:offeringId/analytics/activities/responsesResponds with all learner activity attempts for open response activities in an offering matching the offeringId. - GETFind assessment marks
/offerings/:offeringId/analytics/marks/assignmentsResponds with all learner assessment marks in an offering matching the offeringId. - GETFind quiz marks
/offerings/:offeringId/analytics/marks/quizzesResponds with all learner quiz marks in an offering matching the offeringId. - GETFind submissions to assessments, including marks if any
/offerings/:offeringId/analytics/submissions/assignmentsResponds with all learner assessment submissions and marks, if any, in an offering matching the offeringId. - GETFind submissions to a specified open response assessment, including marks if any
/offerings/:offeringId/analytics/submissions/open-response/:assessmentIdResponds with all learner assessment submissions and marks, if any, in a specified open response assessment. - GETFind a learner's submission to a specified assessment, including marks if any
/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentIdResponds with the learner's assessment submission and any marks for the submission.
Channels
- GETFind comments
/offerings/:offeringId/analytics/channels/:channelId/commentsResponds with a list of comments made in any posts in a specified channel, within an offering. - GETFind posts
/offerings/:offeringId/analytics/channels/:channelId/postsResponds with a list of posts made in a specified channel, within an offering. - GETFind replies
/offerings/:offeringId/analytics/channels/:channelId/repliesResponds with a list of replies to comments in any posts in a specified channel, within an offering. - GETFind channels
/offerings/:offeringId/channelsResponds with a list of channels in an offering. - POSTAdd channel
/offerings/:offeringId/channelsAdds new channel to the specified offering. - PATCHUpdate channel
/offerings/:offeringId/channels/:channelIdUpdates a channel in an offering. - GETFind learners in a group channel
/offerings/:offeringId/channels/:channelId/learnersFinds all learners in a specified group channel. - POSTAdd learners to a group channel
/offerings/:offeringId/channels/:channelId/learnersAdds a learner to a specified group channel. - DELETERemove learners from a group channel
/offerings/:offeringId/channels/:channelId/learnersRemoves a learner from the specified group channel.
Learner activity
- GETFind learner progress in a specified offering
/offerings/:offeringId/analytics/learners-progressResponds with all learner progress in the offering. - GETFind shared social notes in an offering
/offerings/:offeringId/analytics/social-notesResponds with all shared social notes in a specified offering. - GETFind unit reactions
/offerings/:offeringId/analytics/unit-reactionsResponds with user reactions to units in a specified offering. - GETFind learner progress in all offerings
/users/all/progress?$top=50&$orderby=string&$filter=stringResponds with all learners' progress in all offerings. - GETFind learner's progress in a specified offering
/users/:userEmail/offerings/:offeringId/progressResponds with the learner's progress in a specified offering. - GETFind learner's progress in offerings
/users/:userEmail/progressResponds with the specified learner's progress in all offerings.
Pulses
- GETFind all pulse IDs in the specified offering
/offerings/:offeringId/analytics/pulsesResponds with the IDs of all pulses that learners have responded to in a specified offering. - GETFind pulses by offeringId
/offerings/:offeringId/analytics/pulses/responses?pulseType=submit_text&responseTime=stringResponds with pulse's responses in an offering matching the offeringId. - GETFind pulses by offeringId and pulseId
/offerings/:offeringId/analytics/pulses/:pulseId/responsesResponds with pulse's responses, matching the pulseId, in an offering matching the offeringId.
Badges
- GETFind offering badges
/offerings/:offeringId/badgesResponds with the badge for an offering matching the offeringId. - POSTAward badge
/offerings/:offeringId/users/:userEmail/badges/awardAwards a badge to a user in the offering. - GETFind user's badges
/users/:userEmail/badgesResponds with all badges that the specified user has been awarded.
Assessment groups
- GETFind assessment groups
/offerings/:offeringId/groupsResponds with a list of assessment groups in an offering. - POSTAdd an assessment group
/offerings/:offeringId/groupsCreates a new assessment group in an offering. - GETFind learners in an assessment group
/offerings/:offeringId/groups/:groupId/learnersResponds with a list of learners in a specified assessment group. - POSTAdd a learner to an assessment group
/offerings/:offeringId/groups/:groupId/learnersAdds a learner into the specified assessment group. - DELETERemove a learner from an assessment group
/offerings/:offeringId/groups/:groupId/learners/:userEmailRemoves a learner from the specified assessment group.
Offering metadata
- PUTUpdate offering category metadata
/offerings/:offeringId/metadata/categoryUpdates the offering category metadata. - PUTUpdate offering level metadata
/offerings/:offeringId/metadata/levelUpdates the offering level metadata. - PUTUpdate offering tags metadata
/offerings/:offeringId/metadata/tagsUpdates the offering tags metadata. - PUTUpdate offering topic metadata
/offerings/:offeringId/metadata/topicUpdates the offering topic metadata.
Offering learners
- GETFind offering's users
/offerings/:offeringId/users?facilitators=true&learners=true&markers=trueResponds with a list of users in the offering (facilitators, learners and markers.). - POSTAdds user to the offering
/offerings/:offeringId/usersAdds one or more users to the offering. - GETFind Learners marked by a coach
/offerings/:offeringId/users/:markerEmail/marksResponds with all learners marked by the specified coach. - POSTAdd learners to be marked by a coach
/offerings/:offeringId/users/:markerEmail/marksAdds an array of learners to be marked by the specified coach. - DELETERemove learners from coach's marking list
/offerings/:offeringId/users/:markerEmail/marksRemoves an array of learners from coach's marking list. - DELETERemoves user from the offering
/offerings/:offeringId/users/:userEmailRemoves a user from the offering. - PATCHTransfer a user between offerings
/users/:userEmail/transferMoves the user's access and progress from one offering to another.
Organisation
- GETGets the current organisation
/orgReturns the current organisation info.
Users in iQualify
- POSTAdd new user
/usersCreates a new user. - GETFind user by email
/users/:userEmailResponds with a user matching the specified email. - PATCHUpdate user
/users/:userEmailUpdates the specified user by email. - POSTResend invitation email
/users/:userEmail/invite-emailRe-sends an invitation e-mail to the specified user. - GETFind user's offerings
/users/:userEmail/offeringsResponds with all offerings that the user in. - POSTAdds the user to the specified offerings as a learner
/users/:userEmail/offeringsAdds a user to an array of offerings by offeringId. - POSTAdd permission to user
/users/:userEmail/permissions/:permissionNameAdds additional permissions to the specified user. - PUTSuspend user
/users/:userEmail/suspendSuspends the specified user's account.
API details
- Base URL
https://api.iqualify.com/v1- Authentication
- An API key in the Authorization header
- Operations
- 84 operations on 74 pathsGET 48POST 13PUT 10DELETE 7PATCH 6
- Main resources
- Channels 9Offerings 9Assessment management 8Users in iQualify 8Offering learners 7Assessment data 6Learner activity 6Assessment groups 5Course mappings 5Courses 5
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the iQualify Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the iQualify Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List supported endpoints URLs” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the iQualify Management API?
The iQualify API offers management responses for building learning experiences using your iQualify instance data. Once you’ve registered with iQualify, you… It is listed under Education and has 84 endpoints.
Who publishes the iQualify Management API?
It is listed from Iqualify's public API description (an OpenAPI document), not published by Iqualify on Swastik Codes. Anyone who controls iqualify.com can claim the profile by adding a DNS TXT record.
What is the base URL of the iQualify Management API?
Requests go to https://api.iqualify.com/v1. Endpoint paths are added to this base URL.
How do I authenticate with the iQualify Management API?
With an API key in the Authorization header.
How many endpoints does the iQualify Management API have?
84 operations on 74 paths (48 GET, 13 POST, 10 PUT, 7 DELETE, 6 PATCH). The largest groups are Channels, Offerings, Assessment management, Users in iQualify.
Is forking the iQualify Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.