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 acce
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.iqualify.com/v1
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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](https://www.iqualify.com/help/connecting-iqualify-to-other-systems/api/how-to-access-and-m
| method | path | what the vendor says it does |
|---|---|---|
GET | / | List supported endpoints URLs Responds with all supported endpoints URLs for v2 version. API info |
GET | /course-mappings | Find course mappings Returns all course mappings for course offerings. Course mappings |
GET | /course-mappings/externalcourse/{externalCourseId} | Find course mappings by externalCourseId Responds with course mapping details by externalCourseId. Course mapp |
GET | /course-mappings/{offeringId} | Find course mappings by offeringId Responds with course mapping details by offeringId. Course mappings |
PUT | /course-mappings/{offeringId}/{externalCourseId} | Add course mapping Creates a mapping between the offering and the externalCourseId. Course mappings |
DELETE | /course-mappings/{offeringId}/{externalCourseId} | Remove course mapping Removes the course mapping between the offering and the externalCourseId. Course mapping |
GET | /courses | Find courses Responds with all courses (draft and published.) Courses |
GET | /courses/{contentId} | Find course by contentId Responds with a course matching the contentId. Courses |
GET | /courses/{contentId}/activations | Find activations for a contentId Responds with all activations for the contentId provided. Courses |
PUT | /courses/{contentId}/metadata/category | Update course category Add or update course category in the metadata of a course. Course metadata |
PUT | /courses/{contentId}/metadata/level | Update course level Add or update the course level in the metadata of a course. Course metadata |
PUT | /courses/{contentId}/metadata/tags | Update course tags Add or update course tags in the metadata of a course. Course metadata |
PUT | /courses/{contentId}/metadata/topic | Update course topic Add or update the course topic in the metadata of a course. Course metadata |
GET | /courses/{contentId}/permissions | Find users who have access to the contentId provided Responds with users who have access to a specific course |
POST | /courses/{rootContentId}/permissions/{userEmail} | Update course access Provide a user with access to a specific course by rootContentId. Courses |
GET | /offerings | Find current, past and future offerings Responds with all offerings for your organisation. Offerings |
POST | /offerings | Create offering Creates a new offering. Offerings |
GET | /offerings/current | Find active offerings Responds with active offerings for your organisation. Offerings |
GET | /offerings/future | Find scheduled offerings Responds with scheduled offerings for your organisation. Scheduled offerings have a s |
GET | /offerings/info/{textPattern} | Find offerings where info field matches the specified textPattern Find offerings where info field matches the |
GET | /offerings/past | Find past offerings Responds with past offerings for your organisation. Offerings |
GET | /offerings/summary | Offerings summary Responds with a summary of all offerings for your organisation. Offerings |
GET | /offerings/{offeringId} | Find offering by ID Responds with an offering matching the offeringId. Offerings |
PATCH | /offerings/{offeringId} | Update offering Updates the offering. Offerings |
GET | /offerings/{offeringId}/activities/openresponse | Find offering's activities Responds with the activities in a specific offering. Assessment management |
GET | /offerings/{offeringId}/analytics/activities/responses | Find open response activity attempts Responds with all learner activity attempts for open response activities |
GET | /offerings/{offeringId}/analytics/channels/{channelId}/comments | Find comments Responds with a list of comments made in any posts in a specified channel, within an offering. C |
GET | /offerings/{offeringId}/analytics/channels/{channelId}/posts | Find posts Responds with a list of posts made in a specified channel, within an offering. Channels |
GET | /offerings/{offeringId}/analytics/channels/{channelId}/replies | Find replies Responds with a list of replies to comments in any posts in a specified channel, within an offeri |
GET | /offerings/{offeringId}/analytics/learners-progress | Find learner progress in a specified offering Responds with all learner progress in the offering. Learner acti |
GET | /offerings/{offeringId}/analytics/marks/assignments | Find assessment marks Responds with all learner assessment marks in an offering matching the offeringId. Asses |
GET | /offerings/{offeringId}/analytics/marks/quizzes | Find quiz marks Responds with all learner quiz marks in an offering matching the offeringId. Assessment data |
GET | /offerings/{offeringId}/analytics/pulses | Find all pulse IDs in the specified offering Responds with the IDs of all pulses that learners have responded |
GET | /offerings/{offeringId}/analytics/pulses/responses | Find pulses by offeringId Responds with pulse's responses in an offering matching the offeringId. Pulses |
GET | /offerings/{offeringId}/analytics/pulses/{pulseId}/responses | Find pulses by offeringId and pulseId Responds with pulse's responses, matching the pulseId, in an offering ma |
GET | /offerings/{offeringId}/analytics/social-notes | Find shared social notes in an offering Responds with all shared social notes in a specified offering. Learner |
GET | /offerings/{offeringId}/analytics/submissions/assignments | Find submissions to assessments, including marks if any Responds with all learner assessment submissions and m |
GET | /offerings/{offeringId}/analytics/submissions/open-response/{assessmentId} | Find submissions to a specified open response assessment, including marks if any Responds with all learner ass |
GET | /offerings/{offeringId}/analytics/submissions/{userEmail}/assignments/{assessmentId} | Find a learner's submission to a specified assessment, including marks if any Responds with the learner's asse |
GET | /offerings/{offeringId}/analytics/unit-reactions | Find unit reactions Responds with user reactions to units in a specified offering. Learner activity |
and 44 more operation(s) in this specification, all searchable.
specification origin: https://api.iqualify.com/v1/management.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.