API reference
My training
A person's own training, hours and credit, and reporting training they did (Me keys read; reporting is in the app).
2 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
My training#
POST/v1/training/me.listRead
Your training: mandatory training required for you with due dates, hours owed, given and open this year and before, your training credit and when it lapses (Portugal: you use it on your own initiative, with 10 days' notice), your records (with certificates you can download in the app) and your reports waiting for HR. Report training you did with training_me_report.
- Who can call it
- Me key owner admin hr member
- MCP tool
training_me_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
balanceobjectrequiredYour hours where your country has a training rule (country null: none).
10 fields
personobjectrequired2 fields
idstringrequirednamestringrequired
countrystring | nullrequiredThe country whose training rule applies (Portugal: Código do Trabalho art. 131–134); null: none, the register only.
ruleobject | nullrequired4 fields
hoursnumberrequiredwindow_yearsintegerrequiredcredit_lapse_yearsintegerrequiredmin_sharenumberrequired
as_ofstring | nullrequiredToday, or the last day once they left.
count_fromintegerrequiredYears before it are taken as met (Settings → Training).
this_yearobject | nullrequiredThe year of as_of: hours owed, given (oldest year first) and still open.
6 fields
yearintegerrequiredowednumberrequiredgivennumberrequiredopennumberrequiredbecomes_credit_onstringrequiredHours still open that day become a training credit.
projectedbooleanrequiredA future year hours were brought forward to.
yearsobject[]required6 fields
yearintegerrequiredowednumberrequiredgivennumberrequiredopennumberrequiredbecomes_credit_onstringrequiredHours still open that day become a training credit.
projectedbooleanrequiredA future year hours were brought forward to.
creditsobject[]requiredTraining credits (hours not given by the end of the window): used on the worker's initiative, oldest first, lapsing 3 years after they arose.
7 fields
yearintegerrequiredThe year whose hours were not given.
hoursnumberrequiredarises_onstringrequiredlapses_onstringrequiredusednumberrequiredleftnumberrequiredlapsedbooleanrequired
credit_heldnumberrequiredleavingobject | nullrequiredOwners, admins and HR only, while a last day is set: hours to pay on the final pay (Código do Trabalho art. 134). Bizisy states the hours; payroll pays them.
5 fields
last_daystringrequiredopen_hoursnumberrequiredcredit_hoursnumberrequiredhoursnumberrequiredlawstringrequiredWhy: what the law says is paid on termination.
recordsobject[]requiredYour training, newest first: what counts, what waits for HR, what HR declined and why.
23 fields
idstringrequiredpersonobjectrequired2 fields
idstringrequirednamestringrequired
courseobject | nullrequired2 fields
idstringrequiredtitlestringrequired
titlestringrequiredproviderstring | nullrequiredstartstringrequiredendstringrequiredhoursnumberrequiredschedule"working" | "outside" | "mixed"requiredresult"completed" | "attended" | "failed"requiredkind"training" | "student_worker"requiredinitiative"employer" | "worker_credit"requiredexpires_onstring | nullrequiredcertificateobject | nullrequiredThe certificate file (private): the person and HR in the app; null for managers and machines.
3 fields
namestringrequiredcontent_typestringrequiredsizeintegerrequired
has_certificatebooleanrequiredptobject | nullrequiredAnexo C codes in effect (HR only).
5 fields
areastring | nullrequiredmodalitystringrequiredprovider_typestringrequiredlevelstringrequiredcertificatestringrequired
source"manual" | "csv" | "lms" | "self"requiredstatus"confirmed" | "pending" | "declined"requiredcountsbooleanrequiredConfirmed and completed or attended (or student-worker hours): it counts toward the hours.
decline_reasonstring | nullrequiredWhy HR declined a report (private): the person and HR in the app.
access"full" | "self" | "manager"requiredcreated_atstringrequiredupdated_atstringrequired
pendingintegerrequiredYour reports waiting for HR.
requiredobject[]requiredMandatory training required for you (spec 2026-11-17 §6), most urgent first: overdue, due_soon (within 30 days), due, done, exempt (HR exempted you).
8 fields
rule_idstringrequiredcourseobjectrequired2 fields
idstringrequiredtitlestringrequired
status"overdue" | "due_soon" | "due" | "done" | "exempt"requireddue_onstring | nullrequireddone_onstring | nullrequiredvalid_untilstring | nullrequiredwaiting_for_hrbooleanrequiredblocked"course_archived"required
libraryobject | nullrequiredThe content library your company connected (find its courses with training_content_search), or null.
2 fields
connector"linkedin_learning"requirednamestringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/training/me.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/training/me.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/training/me.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"balance": {
"person": {
"id": "p2",
"name": "Tomás Silva"
},
"country": "PT",
"rule": {
"hours": 40,
"window_years": 2,
"credit_lapse_years": 3,
"min_share": 0.1
},
"as_of": "2026-11-12",
"count_from": 2024,
"this_year": {
"year": 2026,
"owed": 40,
"given": 14,
"open": 26,
"becomes_credit_on": "2028-12-31",
"projected": false
},
"years": [
{
"year": 2024,
"owed": 40,
"given": 24,
"open": 16,
"becomes_credit_on": "2026-12-31",
"projected": false
},
{
"year": 2025,
"owed": 40,
"given": 40,
"open": 0,
"becomes_credit_on": "2027-12-31",
"projected": false
},
{
"year": 2026,
"owed": 40,
"given": 14,
"open": 26,
"becomes_credit_on": "2028-12-31",
"projected": false
}
],
"credits": [],
"credit_held": 0,
"leaving": null
},
"records": [
{
"id": "tr1",
"person": {
"id": "p2",
"name": "Tomás Silva"
},
"course": {
"id": "tc1",
"title": "First aid"
},
"title": "First aid",
"provider": "Cruz Vermelha",
"start": "2026-03-02",
"end": "2026-03-03",
"hours": 8,
"schedule": "working",
"result": "completed",
"kind": "training",
"initiative": "employer",
"expires_on": "2028-03-03",
"certificate": {
"name": "first-aid.pdf",
"content_type": "application/pdf",
"size": 182000
},
"has_certificate": true,
"pt": null,
"source": "manual",
"status": "confirmed",
"counts": true,
"decline_reason": null,
"access": "self",
"created_at": "2026-03-04T10:00:00.000Z",
"updated_at": "2026-03-04T10:00:00.000Z"
}
],
"pending": 0,
"required": [
{
"rule_id": "rl1",
"course": {
"id": "tc1",
"title": "First aid"
},
"status": "due_soon",
"due_on": "2026-12-12",
"done_on": null,
"valid_until": null,
"waiting_for_hr": false,
"blocked": null
}
],
"library": {
"connector": "linkedin_learning",
"name": "LinkedIn Learning"
}
}
}Report training I did#
POST/v1/training/me.reportWrite
Reports training you did yourself: a course of the company (course_id) or a title, provider, start, end, hours, schedule (working, outside, mixed), kind (student_worker for student-worker hours), initiative (worker_credit when you used your training credit) and, optionally, a certificate (training_certificates_upload first). It counts once HR confirms it (HR attests it relates to your job); if HR declines it you see why. Up to 30 reports can wait for HR at once. Only for yourself, in the app.
- Web app only
- Refused for API keys and connected apps. The person reports their own training in the app.
- MCP tool
training_me_reporton My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
course_idstring | nullThe course (its title, provider, hours and Anexo C codes); leave out for a one-off training with a title.
1–100 characters.
titlestringA one-off training's title (required without a course).
1–160 characters.
providerstring | nullUp to 160 characters.
startstringrequiredFirst day (YYYY-MM-DD).
Pattern
^\d{4}-\d{2}-\d{2}$.endstringLast day (default: start). Not in the future: record training once it has happened.
Pattern
^\d{4}-\d{2}-\d{2}$.hoursnumberHours actually attended (default: the course's hours).
From 0 to 2000.
schedule"working" | "outside" | "mixed"working (default: in working hours), outside, or mixed.
kind"training" | "student_worker"training (default), or student_worker: hours a student-worker used for classes and exams, which count (Portugal, art. 131 n.º 4).
initiative"employer" | "worker_credit"employer (default), or worker_credit: training the worker chose under their training credit (Portugal, art. 132).
certificate_file_idstringA certificate uploaded with training_certificates_upload (in the app only).
1–64 characters.
Returns
23 fields
idstringrequiredpersonobjectrequired2 fields
idstringrequirednamestringrequired
courseobject | nullrequired2 fields
idstringrequiredtitlestringrequired
titlestringrequiredproviderstring | nullrequiredstartstringrequiredendstringrequiredhoursnumberrequiredschedule"working" | "outside" | "mixed"requiredresult"completed" | "attended" | "failed"requiredkind"training" | "student_worker"requiredinitiative"employer" | "worker_credit"requiredexpires_onstring | nullrequiredcertificateobject | nullrequiredThe certificate file (private): the person and HR in the app; null for managers and machines.
3 fields
namestringrequiredcontent_typestringrequiredsizeintegerrequired
has_certificatebooleanrequiredptobject | nullrequiredAnexo C codes in effect (HR only).
5 fields
areastring | nullrequiredmodalitystringrequiredprovider_typestringrequiredlevelstringrequiredcertificatestringrequired
source"manual" | "csv" | "lms" | "self"requiredstatus"confirmed" | "pending" | "declined"requiredcountsbooleanrequiredConfirmed and completed or attended (or student-worker hours): it counts toward the hours.
decline_reasonstring | nullrequiredWhy HR declined a report (private): the person and HR in the app.
access"full" | "self" | "manager"requiredcreated_atstringrequiredupdated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/training/me.report \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"course_id": "tc1",
"provider": "AWS",
"start": "2026-04-01",
"end": "2026-04-03",
"hours": 14,
"schedule": "mixed",
"kind": "student_worker",
"initiative": "worker_credit",
"certificate_file_id": "f1"
}'const res = await fetch('https://api.bizisy.com/v1/training/me.report', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"course_id": "tc1",
"provider": "AWS",
"start": "2026-04-01",
"end": "2026-04-03",
"hours": 14,
"schedule": "mixed",
"kind": "student_worker",
"initiative": "worker_credit",
"certificate_file_id": "f1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/training/me.report",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"course_id": "tc1",
"provider": "AWS",
"start": "2026-04-01",
"end": "2026-04-03",
"hours": 14,
"schedule": "mixed",
"kind": "student_worker",
"initiative": "worker_credit",
"certificate_file_id": "f1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "tr1",
"person": {
"id": "p2",
"name": "Tomás Silva"
},
"course": {
"id": "tc1",
"title": "First aid"
},
"title": "First aid",
"provider": "AWS",
"start": "2026-04-01",
"end": "2026-04-03",
"hours": 14,
"schedule": "mixed",
"result": "completed",
"kind": "student_worker",
"initiative": "worker_credit",
"expires_on": "2028-03-03",
"certificate": {
"name": "first-aid.pdf",
"content_type": "application/pdf",
"size": 182000
},
"has_certificate": true,
"pt": null,
"source": "self",
"status": "pending",
"counts": false,
"decline_reason": null,
"access": "self",
"created_at": "2026-03-04T10:00:00.000Z",
"updated_at": "2026-03-04T10:00:00.000Z"
}
}Something missing or wrong on this page? Write to hello@bizisy.com.