Iqualify Management API

iQualify Management API

API version: v1

Auth

ApiKey Authorization in header

Base URL

https://api.iqualify.com/v1

Setup

1. Set your API key in the appropriate header
2. GET / -- verify access
3. POST /offerings/{offeringId}/groups -- create first groups

Endpoints

84 endpoints across 6 groups. See references/api-spec.lap for full details.

root

offerings

course-mappings

courses

org

users

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all pulses?" -> GET /offerings/{offeringId}/analytics/pulses
• "List all responses?" -> GET /offerings/{offeringId}/analytics/pulses/responses
• "List all responses?" -> GET /offerings/{offeringId}/analytics/pulses/{pulseId}/responses
• "List all assignments?" -> GET /offerings/{offeringId}/analytics/marks/assignments
• "List all quizzes?" -> GET /offerings/{offeringId}/analytics/marks/quizzes
• "List all learners-progress?" -> GET /offerings/{offeringId}/analytics/learners-progress
• "List all unit-reactions?" -> GET /offerings/{offeringId}/analytics/unit-reactions
• "List all assignments?" -> GET /offerings/{offeringId}/analytics/submissions/assignments
• "List all social-notes?" -> GET /offerings/{offeringId}/analytics/social-notes
• "List all responses?" -> GET /offerings/{offeringId}/analytics/activities/responses
• "Get open-response details?" -> GET /offerings/{offeringId}/analytics/submissions/open-response/{assessmentId}
• "Get assignment details?" -> GET /offerings/{offeringId}/analytics/submissions/{userEmail}/assignments/{assessmentId}
• "List all groups?" -> GET /offerings/{offeringId}/groups
• "Create a group?" -> POST /offerings/{offeringId}/groups
• "List all learners?" -> GET /offerings/{offeringId}/groups/{groupId}/learners
• "Create a learner?" -> POST /offerings/{offeringId}/groups/{groupId}/learners
• "Delete a learner?" -> DELETE /offerings/{offeringId}/groups/{groupId}/learners/{userEmail}
• "List all posts?" -> GET /offerings/{offeringId}/analytics/channels/{channelId}/posts
• "List all comments?" -> GET /offerings/{offeringId}/analytics/channels/{channelId}/comments
• "List all replies?" -> GET /offerings/{offeringId}/analytics/channels/{channelId}/replies
• "List all channels?" -> GET /offerings/{offeringId}/channels
• "Create a channel?" -> POST /offerings/{offeringId}/channels
• "Partially update a channel?" -> PATCH /offerings/{offeringId}/channels/{channelId}
• "Create a learner?" -> POST /offerings/{offeringId}/channels/{channelId}/learners
• "List all learners?" -> GET /offerings/{offeringId}/channels/{channelId}/learners
• "List all course-mappings?" -> GET /course-mappings
• "Get externalcourse details?" -> GET /course-mappings/externalcourse/{externalCourseId}
• "Get course-mapping details?" -> GET /course-mappings/{offeringId}
• "Update a course-mapping?" -> PUT /course-mappings/{offeringId}/{externalCourseId}
• "Delete a course-mapping?" -> DELETE /course-mappings/{offeringId}/{externalCourseId}
• "List all courses?" -> GET /courses
• "Get course details?" -> GET /courses/{contentId}
• "List all activations?" -> GET /courses/{contentId}/activations
• "List all permissions?" -> GET /courses/{contentId}/permissions
• "List all offerings?" -> GET /offerings
• "Create a offering?" -> POST /offerings
• "List all summary?" -> GET /offerings/summary
• "List all current?" -> GET /offerings/current
• "List all past?" -> GET /offerings/past
• "List all future?" -> GET /offerings/future
• "Get info details?" -> GET /offerings/info/{textPattern}
• "Get offering details?" -> GET /offerings/{offeringId}
• "Partially update a offering?" -> PATCH /offerings/{offeringId}
• "List all badges?" -> GET /offerings/{offeringId}/badges
• "List all assessments?" -> GET /offerings/{offeringId}/assessments
• "Partially update a assessment?" -> PATCH /offerings/{offeringId}/assessments/{assessmentId}
• "Partially update a assessment?" -> PATCH /offerings/{offeringId}/assessments/{assessmentId}/{userEmail}
• "Delete a document?" -> DELETE /offerings/{offeringId}/assessments/{assessmentId}/documents/{documentId}
• "List all pending-submission?" -> GET /offerings/{offeringId}/learners/pending-submission
• "List all openresponse?" -> GET /offerings/{offeringId}/activities/openresponse
• "List all users?" -> GET /offerings/{offeringId}/users
• "Create a user?" -> POST /offerings/{offeringId}/users
• "Delete a user?" -> DELETE /offerings/{offeringId}/users/{userEmail}
• "List all marks?" -> GET /offerings/{offeringId}/users/{markerEmail}/marks
• "Create a mark?" -> POST /offerings/{offeringId}/users/{markerEmail}/marks
• "Create a award?" -> POST /offerings/{offeringId}/users/{userEmail}/badges/award
• "List all open-response?" -> GET /offerings/{offeringId}/users/{userEmail}/submissions/open-response
• "Delete a assessment?" -> DELETE /offerings/{offeringId}/users/{userEmail}/assessments/{assessmentId}
• "List all org?" -> GET /org
• "Get user details?" -> GET /users/{userEmail}
• "Partially update a user?" -> PATCH /users/{userEmail}
• "List all offerings?" -> GET /users/{userEmail}/offerings
• "Create a offering?" -> POST /users/{userEmail}/offerings
• "List all progress?" -> GET /users/{userEmail}/offerings/{offeringId}/progress
• "List all progress?" -> GET /users/all/progress
• "List all progress?" -> GET /users/{userEmail}/progress
• "List all badges?" -> GET /users/{userEmail}/badges
• "Create a invite-email?" -> POST /users/{userEmail}/invite-email
• "Create a user?" -> POST /users
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP