^Login

API Skills

The get_skill action returns staff skills: the certificates, licences, policies and inductions they submit in Microkeeper, with each one's status and expiry date. You can also ask for the skills that are expiring, or the staff who are missing a skill.

Actionget_skill
Business key accessHR/Staff: Read Only

Before you start, make your keys and test your connection: see Microkeeper API.


Get skills

FieldValue
mk_actionget_skill
mk_data{"eusername":["ava_patel"],"status":"all"}

Send {} for every active employee's latest submission of every skill. To narrow it down:

FieldWhat it does
eusername, EID or EmployeeIDA list of staff, such as ["ava_patel","liam_smith"]. Send one of the three
SMIDOne skill's ID, from get_roles or an earlier response. 0 or left out for every skill
statusThe status to return. See below. Defaults to all
recent"1" (the default) for each employee's latest submission of each skill; "0" for every submission
statusReturns
allEvery status
0Draft
1Complete, waiting for approval
2More information required
3Approved
expApproved skills that have expired, or are within the skill's reminder period
4Staff missing the skill. Needs SMID. See below

Response

{
"data": [
{
"SMID": "275",
"skill_title": "Responsible Service of Alcohol (RSA)",
"EID": "53613",
"EmployeeID": null,
"eusername": "ava_patel",
"employee_name": "Ava Patel",
"accepted_by_employee": "Accepted",
"approved_by": "mia_chen",
"can_expire": "1095",
"expiry_date": "2028-10-20",
"signed_date": "2026-10-20",
"status": "Approved",
"number_of_files_attached": 1,
"response_value": ""
}
],
"success": "1",
"authenticated": "1",
"message": "Skill data present"
}
FieldWhat it is
SMIDThe skill's ID
skill_titleThe skill's name
EID, EmployeeID, eusernameThe employee: their Microkeeper ID, your software's ID for them, and their username
employee_nameThe employee's name
accepted_by_employeeAccepted, Declined or Pending
approved_byThe username of whoever approved it
can_expireThe skill's Expiry Limit in days, such as "1095" for 3 years. "0" if it doesn't expire
expiry_dateWhen it expires, YYYY-MM-DD. 0000-00-00 if it has no expiry date
signed_dateWhen the employee submitted it
statusDraft, Complete, More Info or Approved
number_of_files_attachedThe number of files attached, such as a scanned certificate
response_valueThe employee's written answer, if the skill asks for one

Find staff missing a skill

Send status 4 with the skill's SMID:

{"status":"4","SMID":"275"}

The response lists each active employee in the skill's Group who has no approved, current submission, including those whose submission has expired. Each item has SMID, skill_title, EID, EmployeeID, eusername, employee_name, and status Missing.


Errors

  • No staff could be found with this list of EIDs, No staff could be found with this list of EmployeeIDs: none of the staff you sent are active.
  • A SMID must be set to hit the API for missing skills: send SMID with status 4.
  • There are no skill submissions based on the search results, No skill data present: nothing matches.

Add or change skills

Staff submit skills in Microkeeper, and managers review them there: see Skills and Documents. Read them again with get_skill to pick up changes.