Mindtickle
App · 20 actions
Manage people, groups and training invitations in Mindtickle, and follow learners' progress.
Actions
| Action | What it does |
|---|---|
| Add groups to series | Invite everyone in up to 20 groups to a series, or to one module in it. |
| Add user to groups | Put a person into one or more groups. |
| Check job status | Check whether changes Mindtickle queued have finished. |
| Create group | Create a group of people in Mindtickle. |
| Create user | Add a person to Mindtickle, optionally into groups and series. |
| Deactivate user | Deactivate a person so they can no longer use Mindtickle. |
| Delete group | Delete a group from Mindtickle. |
| Get learner progress | Read where a person is in each of their modules: not started, in progress or completed, and when. |
| Get user | Read a person's details, status, groups and series. |
| Invite users to module | Invite up to 500 people to one module of a series. |
| Invite users to series | Invite up to 40 people to a series. |
| List groups | List groups in Mindtickle, or find groups by their exact names. |
| List modules | List the modules in a series, such as courses, quick updates and assessments. |
| List series | List the series, Mindtickle's training programs, on your site. |
| List users | List the people in Mindtickle, optionally only those with given email addresses or in given groups or series. |
| Mark module complete | Mark a course, quick update or assessment as complete for a person, with a full score. |
| Remove groups from series | Take up to 20 groups off a series, or off one module in it. |
| Remove users from group | Take one or more people out of a group. |
| Remove users from series | Take up to 500 people off a series. |
| Update user | Change a person's name or time zone. |
Add groups to series
Invite everyone in up to 20 groups to a series, or to one module in it.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Module
module_idtext - Only this module of the series. Leave empty for the whole series.
- Groups
group_idslistRequired - The groups to add. Up to 20.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example"
}
}Add user to groups
Put a person into one or more groups.
Inputs
- User
learner_idtextRequired - The person in Mindtickle.
- Groups
group_idslistRequired - The groups to add. Up to 20.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example"
}
}Check job status
Check whether changes Mindtickle queued have finished. Other Mindtickle steps return job IDs when they're still running.
Inputs
- Job IDs
process_idslistRequired - The job IDs another Mindtickle step returned.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"jobs": [
{
"processId": "example",
"status": "example"
}
]
}
}Create group
Create a group of people in Mindtickle.
Inputs
- Name
nametextRequired - The group's name, 3 to 50 characters.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"id": "example",
"name": "example"
}
}Create user
Add a person to Mindtickle, optionally into groups and series. If someone with the same email address or username is already there, Mindtickle updates them instead. Waits briefly for Mindtickle to finish and returns the person.
Inputs
- Name
nametext - The person's full name.
- Email
emailtext - The person's email address. Mindtickle sends invitations and reminders here.
- Username
usernametext - Only for Mindtickle sites that sign people in with a username instead of an email address.
- Time zone
timezonetext - The person's time zone in Mindtickle.
- Groups
group_idslist - Groups to put the person in.
- Series
series_idslist - Series to invite the person to.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example",
"user": {
"email": "example",
"groupIds": [
"example"
],
"id": "example",
"managers": [
{
"email": "example",
"key": "example",
"username": "example"
}
],
"name": "example",
"profile": {},
"seriesEntities": [
{
"entities": [
"example"
],
"seriesId": "example"
}
],
"source": "example",
"timezone": "example",
"userState": "example",
"username": "example"
}
}
}Deactivate user
Deactivate a person so they can no longer use Mindtickle. Updating them later makes them active again.
Inputs
- User
learner_idtextRequired - The person in Mindtickle.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example"
}
}Delete group
Delete a group from Mindtickle. The people in it stay.
Inputs
- Group
group_idtextRequired - The group in Mindtickle.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"deleted": true
}
}Get learner progress
Read where a person is in each of their modules: not started, in progress or completed, and when.
Inputs
- User
learner_idtextRequired - The person in Mindtickle.
- Status
statustext - Only modules in this state.One of:
not_started(Not started),in_progress(In progress),completed.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"statements": [
{
"actor": {
"mbox": "example",
"name": "example"
},
"id": "example",
"object": {
"definition": {},
"id": "example"
},
"stored": "example",
"timestamp": "example",
"verb": {
"display": {},
"id": "example"
}
}
]
}
}Get user
Read a person's details, status, groups and series.
Inputs
- User
learner_idtextRequired - The person in Mindtickle.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"email": "example",
"groupIds": [
"example"
],
"id": "example",
"managers": [
{
"email": "example",
"key": "example",
"username": "example"
}
],
"name": "example",
"profile": {},
"seriesEntities": [
{
"entities": [
"example"
],
"seriesId": "example"
}
],
"source": "example",
"timezone": "example",
"userState": "example",
"username": "example"
}
}Invite users to module
Invite up to 500 people to one module of a series.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Module
module_idtextRequired - The module in the chosen series.
- Users
learner_idslistRequired - The people to invite. Up to 500.
- Relevance
relevancetext - Whether the module is required or optional for these people.One of:
required,optional,unmarked. - Invited on
invited_ondate and time - Record the invitation as made at this earlier time, so past completions count. Leave empty to invite now.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"message": "example",
"success": true
}
}Invite users to series
Invite up to 40 people to a series.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Users
learner_idslistRequired - The people to invite. Up to 40.
- Invited on
invited_ondate and time - Record the invitation as made at this earlier time, so past completions count. Leave empty to invite now.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"message": "example",
"success": true
}
}List groups
List groups in Mindtickle, or find groups by their exact names.
Inputs
- Names
nameslist - Only groups with exactly these names.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"groups": [
{
"id": "example",
"name": "example"
}
]
}
}List modules
List the modules in a series, such as courses, quick updates and assessments.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"modules": [
{
"description": "example",
"id": "example",
"moduleType": "example",
"name": "example",
"thumbnailUrl": "example"
}
]
}
}List series
List the series, Mindtickle's training programs, on your site.
Inputs
None.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"series": [
{
"description": "example",
"id": "example",
"moduleType": "example",
"name": "example"
}
]
}
}List users
List the people in Mindtickle, optionally only those with given email addresses or in given groups or series. Returns up to 2,000 people.
Inputs
- Email addresses
emailslist - Only these email addresses.
- Usernames
usernameslist - Only these usernames, on sites that sign people in with a username.
- Groups
group_idslist - Only people in these groups.
- Series
series_idslist - Only people invited to these series.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"done": true,
"totalSize": 1,
"users": [
{
"email": "example",
"groupIds": [
"example"
],
"id": "example",
"managers": [
{
"email": "example",
"key": "example",
"username": "example"
}
],
"name": "example",
"profile": {},
"seriesEntities": [
{
"entities": [
"example"
],
"seriesId": "example"
}
],
"source": "example",
"timezone": "example",
"userState": "example",
"username": "example"
}
]
}
}Mark module complete
Mark a course, quick update or assessment as complete for a person, with a full score. The person must already be invited to the series.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Module
module_idtextRequired - The module in the chosen series.
- User
learner_idtextRequired - The person in Mindtickle.
- Completed on
completed_ondate and time - When the person finished. Leave empty for now. It can't be in the future or before they were invited.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"completionStatus": true,
"requestId": "example"
}
}Remove groups from series
Take up to 20 groups off a series, or off one module in it.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Module
module_idtext - Only this module of the series. Leave empty for the whole series.
- Groups
group_idslistRequired - The groups to remove. Up to 20.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example"
}
}Remove users from group
Take one or more people out of a group. Up to 500 at a time.
Inputs
- Group
group_idtextRequired - The group in Mindtickle.
- Users
learner_idslistRequired - The people in Mindtickle.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"message": "example",
"success": true
}
}Remove users from series
Take up to 500 people off a series.
Inputs
- Series
series_idtextRequired - The series, Mindtickle's name for a training program that holds modules.
- Users
learner_idslistRequired - The people to remove. Up to 500.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"message": "example",
"success": true
}
}Update user
Change a person's name or time zone. Anything left empty stays as it is. Updating someone who was deactivated makes them active again.
Inputs
- User
learner_idtextRequired - The person in Mindtickle.
- Name
nametext - The person's new full name.
- Time zone
timezonetext - The person's time zone in Mindtickle.
Outputs
dataobject- The response from Mindtickle.
Example output
{
"data": {
"processIds": [
"example"
],
"status": "example"
}
}