actionPOSTv1.0.0
Add a learner to an assessment group
Adds a learner into the specified assessment group.
actionPOSTv1.0.0
Add an assessment group
Creates a new assessment group in an offering.
actionPOSTv1.0.0
Add channel
Adds new channel to the specified offering.
actionPOSTv1.0.0
Add learners to a group channel
Adds a learner to a specified group channel.
actionPOSTv1.0.0
Add learners to be marked by a coach
Adds an array of learners to be marked by the specified coach.
actionPOSTv1.0.0
Add new user
Creates a new user.
actionPOSTv1.0.0
Add permission to user
Adds additional permissions to the specified user.
actionPOSTv1.0.0
Adds the user to the specified offerings as a learner
Adds a user to an array of offerings by offeringId.
actionPOSTv1.0.0
Adds user to the offering
Adds one or more users to the offering.
actionPOSTv1.0.0
Award badge
Awards a badge to a user in the offering.
actionPOSTv1.0.0
Create offering
Creates a new offering.
actionGETv1.0.0
Find a learner's submission to a specified assessment, including marks if any
Responds with the learner's assessment submission and any marks for the submission.
actionGETv1.0.0
Find activations for a contentId
Responds with all activations for the contentId provided.
actionGETv1.0.0
Find active offerings
Responds with active offerings for your organisation.
actionGETv1.0.0
Find all pulse IDs in the specified offering
Responds with the IDs of all pulses that learners have responded to in a specified offering.
actionGETv1.0.0
Find assessment groups
Responds with a list of assessment groups in an offering.
actionGETv1.0.0
Find assessment marks
Responds with all learner assessment marks in an offering matching the offeringId.
actionGETv1.0.0
Find channels
Responds with a list of channels in an offering.
actionGETv1.0.0
Find comments
Responds with a list of comments made in any posts in a specified channel, within an offering.
actionGETv1.0.0
Find course by contentId
Responds with a course matching the contentId.
actionGETv1.0.0
Find courses
Responds with all courses (draft and published.)
actionGETv1.0.0
Find current, past and future offerings
Responds with all offerings for your organisation.
actionGETv1.0.0
Find learner progress in a specified offering
Responds with all learner progress in the offering.
actionGETv1.0.0
Find learner progress in all offerings
Responds with all learners' progress in all offerings.
actionGETv1.0.0
Find learner's open response assessment submissions
Responds with open response assessment submissions by a learner in an offering.
actionGETv1.0.0
Find learner's progress in a specified offering
Responds with the learner's progress in a specified offering.
actionGETv1.0.0
Find learner's progress in offerings
Responds with the specified learner's progress in all offerings.
actionGETv1.0.0
Find learners in a group channel
Finds all learners in a specified group channel.
actionGETv1.0.0
Find learners in an assessment group
Responds with a list of learners in a specified assessment group.
actionGETv1.0.0
Find Learners marked by a coach
Responds with all learners marked by the specified coach.
actionGETv1.0.0
Find learners with assessments pending x days before due date within the specified offeringId
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.
actionGETv1.0.0
Find offering badges
Responds with the badge for an offering matching the offeringId.
actionGETv1.0.0
Find offering by ID
Responds with an offering matching the offeringId.
actionGETv1.0.0
Find offering's activities
Responds with the activities in a specific offering.
actionGETv1.0.0
Find offering's assessments
Responds with all assessments in an offering matching the offeringId.
actionGETv1.0.0
Find offering's users
Responds with a list of users in the offering (facilitators, learners and markers.).
actionGETv1.0.0
Find offerings where info field matches the specified textPattern
Find offerings where info field matches the specified text pattern.
actionGETv1.0.0
Find open response activity attempts
Responds with all learner activity attempts for open response activities in an offering matching the offeringId.
actionGETv1.0.0
Find past offerings
Responds with past offerings for your organisation.
actionGETv1.0.0
Find posts
Responds with a list of posts made in a specified channel, within an offering.
actionGETv1.0.0
Find pulses by offeringId
Responds with pulse's responses in an offering matching the offeringId.
actionGETv1.0.0
Find pulses by offeringId and pulseId
Responds with pulse's responses, matching the pulseId, in an offering matching the offeringId.
actionGETv1.0.0
Find quiz marks
Responds with all learner quiz marks in an offering matching the offeringId.
actionGETv1.0.0
Find replies
Responds with a list of replies to comments in any posts in a specified channel, within an offering.
actionGETv1.0.0
Find scheduled offerings
Responds with scheduled offerings for your organisation. Scheduled offerings have a start date after today's date (inclusive).
actionGETv1.0.0
Find shared social notes in an offering
Responds with all shared social notes in a specified offering.
actionGETv1.0.0
Find submissions to a specified open response assessment, including marks if any
Responds with all learner assessment submissions and marks, if any, in a specified open response assessment.
actionGETv1.0.0
Find submissions to assessments, including marks if any
Responds with all learner assessment submissions and marks, if any, in an offering matching the offeringId.
actionGETv1.0.0
Find unit reactions
Responds with user reactions to units in a specified offering.
actionGETv1.0.0
Find user by email
Responds with a user matching the specified email.
actionGETv1.0.0
Find user's badges
Responds with all badges that the specified user has been awarded.
actionGETv1.0.0
Find user's offerings
Responds with all offerings that the user in.
actionGETv1.0.0
Find users who have access to the contentId provided
Responds with users who have access to a specific course by contentId.
actionGETv1.0.0
Gets the current organisation
Returns the current organisation info.
actionGETv1.0.0
List supported endpoints URLs
Responds with all supported endpoints URLs for v2 version.
actionGETv1.0.0
Offerings summary
Responds with a summary of all offerings for your organisation.
actionDELETEv1.0.0
Remove a learner from an assessment group
Removes a learner from the specified assessment group.
actionDELETEv1.0.0
Remove assessment document
Removes the assessment document file for a specified assessment in an offering.
actionDELETEv1.0.0
Remove learners from a group channel
Removes a learner from the specified group channel.
actionDELETEv1.0.0
Remove learners from coach's marking list
Removes an array of learners from coach's marking list.
actionDELETEv1.0.0
Removes user from the offering
Removes a user from the offering.
actionPOSTv1.0.0
Resend invitation email
Re-sends an invitation e-mail to the specified user.
actionDELETEv1.0.0
Reset user's assessment to draft state
Resets the user's submitted assessment to a draft state.
actionPUTv1.0.0
Suspend user
Suspends the specified user's account.
actionPATCHv1.0.0
Transfer a user between offerings
Moves the user's access and progress from one offering to another.
actionPATCHv1.0.0
Update assessment details
Updates the assessment details for a specified assessment in an offering.
actionPATCHv1.0.0
Update channel
Updates a channel in an offering.
actionPOSTv1.0.0
Update course access
Provide a user with access to a specific course by rootContentId.
actionPUTv1.0.0
Update course category
Add or update course category in the metadata of a course.
actionPUTv1.0.0
Update course level
Add or update the course level in the metadata of a course.
actionPUTv1.0.0
Update course tags
Add or update course tags in the metadata of a course.
actionPUTv1.0.0
Update course topic
Add or update the course topic in the metadata of a course.
actionPATCHv1.0.0
Update offering
Updates the offering.
actionPUTv1.0.0
Update offering category metadata
Updates the offering category metadata.
actionPUTv1.0.0
Update offering level metadata
Updates the offering level metadata.
actionPUTv1.0.0
Update offering tags metadata
Updates the offering tags metadata.
actionPUTv1.0.0
Update offering topic metadata
Updates the offering topic metadata.
actionPATCHv1.0.0
Update the due dates for a learner's quiz attempt
Updates the due dates for a learner's quiz attempt specified by the assessmentId.
actionPATCHv1.0.0
Update user
Updates the specified user by email.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec