Skip to content

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_list on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • balanceobjectrequired

    Your hours where your country has a training rule (country null: none).

    10 fields
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • countrystring | nullrequired

      The country whose training rule applies (Portugal: Código do Trabalho art. 131–134); null: none, the register only.

    • ruleobject | nullrequired
      4 fields
      • hoursnumberrequired
      • window_yearsintegerrequired
      • credit_lapse_yearsintegerrequired
      • min_sharenumberrequired
    • as_ofstring | nullrequired

      Today, or the last day once they left.

    • count_fromintegerrequired

      Years before it are taken as met (Settings → Training).

    • this_yearobject | nullrequired

      The year of as_of: hours owed, given (oldest year first) and still open.

      6 fields
      • yearintegerrequired
      • owednumberrequired
      • givennumberrequired
      • opennumberrequired
      • becomes_credit_onstringrequired

        Hours still open that day become a training credit.

      • projectedbooleanrequired

        A future year hours were brought forward to.

    • yearsobject[]required
      6 fields
      • yearintegerrequired
      • owednumberrequired
      • givennumberrequired
      • opennumberrequired
      • becomes_credit_onstringrequired

        Hours still open that day become a training credit.

      • projectedbooleanrequired

        A future year hours were brought forward to.

    • creditsobject[]required

      Training 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
      • yearintegerrequired

        The year whose hours were not given.

      • hoursnumberrequired
      • arises_onstringrequired
      • lapses_onstringrequired
      • usednumberrequired
      • leftnumberrequired
      • lapsedbooleanrequired
    • credit_heldnumberrequired
    • leavingobject | nullrequired

      Owners, 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_daystringrequired
      • open_hoursnumberrequired
      • credit_hoursnumberrequired
      • hoursnumberrequired
      • lawstringrequired

        Why: what the law says is paid on termination.

  • recordsobject[]required

    Your training, newest first: what counts, what waits for HR, what HR declined and why.

    23 fields
    • idstringrequired
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • courseobject | nullrequired
      2 fields
      • idstringrequired
      • titlestringrequired
    • titlestringrequired
    • providerstring | nullrequired
    • startstringrequired
    • endstringrequired
    • hoursnumberrequired
    • schedule"working" | "outside" | "mixed"required
    • result"completed" | "attended" | "failed"required
    • kind"training" | "student_worker"required
    • initiative"employer" | "worker_credit"required
    • expires_onstring | nullrequired
    • certificateobject | nullrequired

      The certificate file (private): the person and HR in the app; null for managers and machines.

      3 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
    • has_certificatebooleanrequired
    • ptobject | nullrequired

      Anexo C codes in effect (HR only).

      5 fields
      • areastring | nullrequired
      • modalitystringrequired
      • provider_typestringrequired
      • levelstringrequired
      • certificatestringrequired
    • source"manual" | "csv" | "lms" | "self"required
    • status"confirmed" | "pending" | "declined"required
    • countsbooleanrequired

      Confirmed and completed or attended (or student-worker hours): it counts toward the hours.

    • decline_reasonstring | nullrequired

      Why HR declined a report (private): the person and HR in the app.

    • access"full" | "self" | "manager"required
    • created_atstringrequired
    • updated_atstringrequired
  • pendingintegerrequired

    Your reports waiting for HR.

  • requiredobject[]required

    Mandatory 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_idstringrequired
    • courseobjectrequired
      2 fields
      • idstringrequired
      • titlestringrequired
    • status"overdue" | "due_soon" | "due" | "done" | "exempt"required
    • due_onstring | nullrequired
    • done_onstring | nullrequired
    • valid_untilstring | nullrequired
    • waiting_for_hrbooleanrequired
    • blocked"course_archived"required
  • libraryobject | nullrequired

    The content library your company connected (find its courses with training_content_search), or null.

    2 fields
    • connector"linkedin_learning"required
    • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/me.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "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_report on My Workplace
Preview
?dry_run=true runs 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 | null

    The course (its title, provider, hours and Anexo C codes); leave out for a one-off training with a title.

    1–100 characters.

  • titlestring

    A one-off training's title (required without a course).

    1–160 characters.

  • providerstring | null

    Up to 160 characters.

  • startstringrequired

    First day (YYYY-MM-DD).

    Pattern ^\d{4}-\d{2}-\d{2}$.

  • endstring

    Last day (default: start). Not in the future: record training once it has happened.

    Pattern ^\d{4}-\d{2}-\d{2}$.

  • hoursnumber

    Hours 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_idstring

    A certificate uploaded with training_certificates_upload (in the app only).

    1–64 characters.

Returns

23 fields
  • idstringrequired
  • personobjectrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • courseobject | nullrequired
    2 fields
    • idstringrequired
    • titlestringrequired
  • titlestringrequired
  • providerstring | nullrequired
  • startstringrequired
  • endstringrequired
  • hoursnumberrequired
  • schedule"working" | "outside" | "mixed"required
  • result"completed" | "attended" | "failed"required
  • kind"training" | "student_worker"required
  • initiative"employer" | "worker_credit"required
  • expires_onstring | nullrequired
  • certificateobject | nullrequired

    The certificate file (private): the person and HR in the app; null for managers and machines.

    3 fields
    • namestringrequired
    • content_typestringrequired
    • sizeintegerrequired
  • has_certificatebooleanrequired
  • ptobject | nullrequired

    Anexo C codes in effect (HR only).

    5 fields
    • areastring | nullrequired
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • source"manual" | "csv" | "lms" | "self"required
  • status"confirmed" | "pending" | "declined"required
  • countsbooleanrequired

    Confirmed and completed or attended (or student-worker hours): it counts toward the hours.

  • decline_reasonstring | nullrequired

    Why HR declined a report (private): the person and HR in the app.

  • access"full" | "self" | "manager"required
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
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"
}'
Response
{
  "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.

Developer docs