This guide explains how to get skills data via API.
Before starting this tutorial make sure you have completed the Hello World tutorial.
The skills API allows you to retrieve skill assessments, their status, and related information for employees.
Step 1
Set the mk_action variable and mk_data variable.
Variable name | Values and example |
mk_action | get_skill |
mk_data | { "GID": "0", "employee": "", "status": "all", "SMID": "0", "recent": "1" } |
Step 2
Below is a list of variables that can be used to get skills data.
Variable name | Description | Required | Accepted Formats | Example |
GID | Group ID to filter skills by | FALSE | Integer | 123 |
employee | Employee username(s) to filter by | FALSE | Usernames separated by @ symbol | john_smith@jane_doe |
status | Status filter for skills | FALSE | String "all", "0", "1", "2", "3", "4", "exp" | all |
SMID | Specific Skill ID to retrieve | FALSE | Integer | 456 |
recent | Get only most recent submission. Must be sent as string "1" or "0" in the JSON data. | FALSE | String "1" or "0" | "1" |
Status | Description |
0 | Draft |
1 | Complete |
2 | More Info Required |
3 | Approved |
4 | Missing |
exp | Expired or Expiring |
Field name | Description | Format | Example |
SMID | Unique Skill ID | Integer | 123 |
skill_title | Name of the skill | String | First Aid |
EID | Employee ID | Integer | 456 |
EmployeeID | Third party employee ID. Can be numeric or prefixed with "E" | String | "1" or "E3" |
eusername | Employee username | String | john_smith |
employee_name | Full name of employee | String | John Smith |
accepted_by_employee | Employee acceptance status | String | Accepted |
approved_by | Username of approver | String | jane_doe |
can_expire | Indicates if the skill can expire. 1 = yes, 0 = no | String "0" or "1" | "1" |
expiry_date | Date skill expires. Returns "0000-00-00" if no expiry date set. | YYYY-MM-DD | 2025-03-29 |
signed_date | Date skill was signed | YYYY-MM-DD | 2025-03-28 |
status | Current status of skill | String | "Draft", "Complete", "More Info Required", "Approved" |
number_of_files_attached | Count of attached files | Integer | 0 |
response_value | Employee's response text. Can be empty string. | String | "Completed first aid training" or "" |
Successful response example
{ "success":"1", "authenticated":"1", "message":"Skill data present", "data": [{ "SMID":"123", "skill_title":"First Aid", "EID":"456", "EmployeeID":"E456", "eusername":"john_smith", "employee_name":"John Smith", "accepted_by_employee":"Accepted", "approved_by":"jane_doe", "skill_expiry_date":"2024-12-31", "signed_date":"2024-01-01", "status":"Approved", "number_of_files_attached":2, "response_value":"Completed first aid training" }] }
Same example readable
Array
(
[success] => 1
[authenticated] => 1
[message] => Skill data present
[data] => Array
(
[0] => Array
(
[SMID] => 123
[skill_title] => First Aid
[EID] => 456
[EmployeeID] => E456
[eusername] => john_smith
[employee_name] => John Smith
[accepted_by_employee] => Accepted
[approved_by] => jane_doe
[skill_expiry_date] => 2024-12-31
[signed_date] => 2024-01-01
[status] => Approved
[number_of_files_attached] => 2
[response_value] => Completed first aid training
)
)
)
This feature is not yet available via the Microkeeper API, reach out to our support staff to discuss your options.