integrations.sh
← all integrations

iQualify Management API

OpenAPI apis-guru education

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 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
Homepage
https://api.apis.guru/v2/specs/iqualify.com/v1.json
Provider
iqualify.com
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/iqualify.com/v1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/iqualify.com/v1/openapi.yaml

Tools (86)

Extracted live via the executor SDK.

  • apiInfo.get

    Responds with all supported endpoints URLs for v2 version.

  • assessmentData.getOfferingsOfferingIdAnalyticsActivitiesResponses

    Responds with all learner activity attempts for open response activities in an offering matching the offeringId.

  • assessmentData.getOfferingsOfferingIdAnalyticsMarksAssignments

    Responds with all learner assessment marks in an offering matching the offeringId.

  • assessmentData.getOfferingsOfferingIdAnalyticsMarksQuizzes

    Responds with all learner quiz marks in an offering matching the offeringId.

  • assessmentData.getOfferingsOfferingIdAnalyticsSubmissionsAssignments

    Responds with all learner assessment submissions and marks, if any, in an offering matching the offeringId.

  • assessmentData.getOfferingsOfferingIdAnalyticsSubmissionsOpenResponseAssessmentId

    Responds with all learner assessment submissions and marks, if any, in a specified open response assessment.

  • assessmentData.getOfferingsOfferingIdAnalyticsSubmissionsUserEmailAssignmentsAssessmentId

    Responds with the learner's assessment submission and any marks for the submission.

  • assessmentGroups.deleteOfferingsOfferingIdGroupsGroupIdLearnersUserEmail

    Removes a learner from the specified assessment group.

  • assessmentGroups.getOfferingsOfferingIdGroups

    Responds with a list of assessment groups in an offering.

  • assessmentGroups.getOfferingsOfferingIdGroupsGroupIdLearners

    Responds with a list of learners in a specified assessment group.

  • assessmentGroups.postOfferingsOfferingIdGroups

    Creates a new assessment group in an offering.

  • assessmentGroups.postOfferingsOfferingIdGroupsGroupIdLearners

    Adds a learner into the specified assessment group.

  • assessmentManagement.deleteOfferingsOfferingIdAssessmentsAssessmentIdDocumentsDocumentId

    Removes the assessment document file for a specified assessment in an offering.

  • assessmentManagement.deleteOfferingsOfferingIdUsersUserEmailAssessmentsAssessmentId

    Resets the user's submitted assessment to a draft state.

  • assessmentManagement.getOfferingsOfferingIdActivitiesOpenresponse

    Responds with the activities in a specific offering.

  • assessmentManagement.getOfferingsOfferingIdAssessments

    Responds with all assessments in an offering matching the offeringId.

  • assessmentManagement.getOfferingsOfferingIdLearnersPendingSubmission

    Responds 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 specified in the request. The default is 3 days.

  • assessmentManagement.getOfferingsOfferingIdUsersUserEmailSubmissionsOpenResponse

    Responds with open response assessment submissions by a learner in an offering.

  • assessmentManagement.patchOfferingsOfferingIdAssessmentsAssessmentId

    Updates the assessment details for a specified assessment in an offering.

  • assessmentManagement.patchOfferingsOfferingIdAssessmentsAssessmentIdUserEmail

    Updates the due dates for a learner's quiz attempt specified by the assessmentId.

  • badges.getOfferingsOfferingIdBadges

    Responds with the badge for an offering matching the offeringId.

  • badges.getUsersUserEmailBadges

    Responds with all badges that the specified user has been awarded.

  • badges.postOfferingsOfferingIdUsersUserEmailBadgesAward

    Awards a badge to a user in the offering.

  • channels.deleteOfferingsOfferingIdChannelsChannelIdLearners

    Removes a learner from the specified group channel.

  • channels.getOfferingsOfferingIdAnalyticsChannelsChannelIdComments

    Responds with a list of comments made in any posts in a specified channel, within an offering.

  • channels.getOfferingsOfferingIdAnalyticsChannelsChannelIdPosts

    Responds with a list of posts made in a specified channel, within an offering.

  • channels.getOfferingsOfferingIdAnalyticsChannelsChannelIdReplies

    Responds with a list of replies to comments in any posts in a specified channel, within an offering.

  • channels.getOfferingsOfferingIdChannels

    Responds with a list of channels in an offering.

  • channels.getOfferingsOfferingIdChannelsChannelIdLearners

    Finds all learners in a specified group channel.

  • channels.patchOfferingsOfferingIdChannelsChannelId

    Updates a channel in an offering.

  • channels.postOfferingsOfferingIdChannels

    Adds new channel to the specified offering.

  • channels.postOfferingsOfferingIdChannelsChannelIdLearners

    Adds a learner to a specified group channel.

  • courseMappings.deleteCourseMappingsOfferingIdExternalCourseId

    Removes the course mapping between the offering and the externalCourseId.

  • courseMappings.getCourseMappings

    Returns all course mappings for course offerings.

  • courseMappings.getCourseMappingsExternalcourseExternalCourseId

    Responds with course mapping details by externalCourseId.

  • courseMappings.getCourseMappingsOfferingId

    Responds with course mapping details by offeringId.

  • courseMappings.putCourseMappingsOfferingIdExternalCourseId

    Creates a mapping between the offering and the externalCourseId.

  • courseMetadata.putCoursesContentIdMetadataCategory

    Add or update course category in the metadata of a course.

  • courseMetadata.putCoursesContentIdMetadataLevel

    Add or update the course level in the metadata of a course.

  • courseMetadata.putCoursesContentIdMetadataTags

    Add or update course tags in the metadata of a course.

  • courseMetadata.putCoursesContentIdMetadataTopic

    Add or update the course topic in the metadata of a course.

  • courses.getCourses

    Responds with all courses (draft and published.)

  • courses.getCoursesContentId

    Responds with a course matching the contentId.

  • courses.getCoursesContentIdActivations

    Responds with all activations for the contentId provided.

  • courses.getCoursesContentIdPermissions

    Responds with users who have access to a specific course by contentId.

  • courses.postCoursesRootContentIdPermissionsUserEmail

    Provide a user with access to a specific course by rootContentId.

  • learnerActivity.getOfferingsOfferingIdAnalyticsLearnersProgress

    Responds with all learner progress in the offering.

  • learnerActivity.getOfferingsOfferingIdAnalyticsSocialNotes

    Responds with all shared social notes in a specified offering.

  • learnerActivity.getOfferingsOfferingIdAnalyticsUnitReactions

    Responds with user reactions to units in a specified offering.

  • learnerActivity.getUsersAllProgress

    Responds with all learners' progress in all offerings.

  • learnerActivity.getUsersUserEmailOfferingsOfferingIdProgress

    Responds with the learner's progress in a specified offering.

  • learnerActivity.getUsersUserEmailProgress

    Responds with the specified learner's progress in all offerings.

  • offeringLearners.deleteOfferingsOfferingIdUsersMarkerEmailMarks

    Removes an array of learners from coach's marking list.

  • offeringLearners.deleteOfferingsOfferingIdUsersUserEmail

    Removes a user from the offering.

  • offeringLearners.getOfferingsOfferingIdUsers

    Responds with a list of users in the offering (facilitators, learners and markers.).

  • offeringLearners.getOfferingsOfferingIdUsersMarkerEmailMarks

    Responds with all learners marked by the specified coach.

  • offeringLearners.patchUsersUserEmailTransfer

    Moves the user's access and progress from one offering to another.

  • offeringLearners.postOfferingsOfferingIdUsers

    Adds one or more users to the offering.

  • offeringLearners.postOfferingsOfferingIdUsersMarkerEmailMarks

    Adds an array of learners to be marked by the specified coach.

  • offeringMetadata.putOfferingsOfferingIdMetadataCategory

    Updates the offering category metadata.

  • offeringMetadata.putOfferingsOfferingIdMetadataLevel

    Updates the offering level metadata.

  • offeringMetadata.putOfferingsOfferingIdMetadataTags

    Updates the offering tags metadata.

  • offeringMetadata.putOfferingsOfferingIdMetadataTopic

    Updates the offering topic metadata.

  • offerings.getOfferings

    Responds with all offerings for your organisation.

  • offerings.getOfferingsCurrent

    Responds with active offerings for your organisation.

  • offerings.getOfferingsFuture

    Responds with scheduled offerings for your organisation. Scheduled offerings have a start date after today's date (inclusive).

  • offerings.getOfferingsInfoTextPattern

    Find offerings where info field matches the specified text pattern.

  • offerings.getOfferingsOfferingId

    Responds with an offering matching the offeringId.

  • offerings.getOfferingsPast

    Responds with past offerings for your organisation.

  • offerings.getOfferingsSummary

    Responds with a summary of all offerings for your organisation.

  • offerings.patchOfferingsOfferingId

    Updates the offering.

  • offerings.postOfferings

    Creates a new offering.

  • organisation.getOrg

    Returns the current organisation info.

  • pulses.getOfferingsOfferingIdAnalyticsPulses

    Responds with the IDs of all pulses that learners have responded to in a specified offering.

  • pulses.getOfferingsOfferingIdAnalyticsPulsesPulseIdResponses

    Responds with pulse's responses, matching the pulseId, in an offering matching the offeringId.

  • pulses.getOfferingsOfferingIdAnalyticsPulsesResponses

    Responds with pulse's responses in an offering matching the offeringId.

  • usersInIQualify.getUsersUserEmail

    Responds with a user matching the specified email.

  • usersInIQualify.getUsersUserEmailOfferings

    Responds with all offerings that the user in.

  • usersInIQualify.patchUsersUserEmail

    Updates the specified user by email.

  • usersInIQualify.postUsers

    Creates a new user.

  • usersInIQualify.postUsersUserEmailInviteEmail

    Re-sends an invitation e-mail to the specified user.

  • usersInIQualify.postUsersUserEmailOfferings

    Adds a user to an array of offerings by offeringId.

  • usersInIQualify.postUsersUserEmailPermissionsPermissionName

    Adds additional permissions to the specified user.

  • usersInIQualify.putUsersUserEmailSuspend

    Suspends the specified user's account.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools