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.
| Action | get_skill |
|---|---|
| Business key access | HR/Staff: Read Only |
Before you start, make your keys and test your connection: see Microkeeper API.
Get skills
| Field | Value |
|---|---|
mk_action | get_skill |
mk_data | {"eusername":["ava_patel"],"status":"all"} |
Send {} for every active employee's latest submission of every skill. To narrow it down:
| Field | What it does |
|---|---|
eusername, EID or EmployeeID | A list of staff, such as ["ava_patel","liam_smith"]. Send one of the three |
SMID | One skill's ID, from get_roles or an earlier response. 0 or left out for every skill |
status | The 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 |
status | Returns |
|---|---|
all | Every status |
0 | Draft |
1 | Complete, waiting for approval |
2 | More information required |
3 | Approved |
exp | Approved skills that have expired, or are within the skill's reminder period |
4 | Staff 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"
}| Field | What it is |
|---|---|
SMID | The skill's ID |
skill_title | The skill's name |
EID, EmployeeID, eusername | The employee: their Microkeeper ID, your software's ID for them, and their username |
employee_name | The employee's name |
accepted_by_employee | Accepted, Declined or Pending |
approved_by | The username of whoever approved it |
can_expire | The skill's Expiry Limit in days, such as "1095" for 3 years. "0" if it doesn't expire |
expiry_date | When it expires, YYYY-MM-DD. 0000-00-00 if it has no expiry date |
signed_date | When the employee submitted it |
status | Draft, Complete, More Info or Approved |
number_of_files_attached | The number of files attached, such as a scanned certificate |
response_value | The 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: sendSMIDwithstatus4.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.