Skip to content

API reference

Training register

Mandatory training rules and who is overdue (remind, exempt with a reason), courses and training records (add, import, confirm or decline what people reported), certificates in the app, each person's training hours where a country rule applies (Portugal: 40 hours a year, deferral, credit and what a leaver is paid for), the company summary, and LinkedIn Learning: find a course and assign it to people as tasks that tick themselves.

30 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.

List training courses#

POST/v1/training/courses.listRead

The company's training courses (defined once: title, provider, hours, internal or external, how long certificates last, Portugal's Anexo C codes, mapped learning tool courses), sorted by title. Archived ones only with archived true. Everyone but viewers reads them (people pick one when they report training).

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_courses_list on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • qstring

    Up to 100 characters.

  • archivedboolean

    true: only archived courses.

Returns

  • itemsobject[]required
    12 fields
    • idstringrequired
    • titlestringrequired
    • providerstring | nullrequired
    • hoursnumberrequired
    • delivery"internal" | "external"required
    • validity_monthsinteger | nullrequired
    • ptobjectrequired

      Anexo C codes: the course's own, else Settings → Training defaults (Portugal).

      5 fields
      • areastring | nullrequired
      • modalitystringrequired
      • provider_typestringrequired
      • levelstringrequired
      • certificatestringrequired
    • lmsobject[]required

      Learning tool courses that are this course: a completion there adds a record.

      2 fields
      • connectorstringrequired
      • course_idstringrequired
    • archivedbooleanrequired
    • recordsinteger | nullrequired

      Records from this course (HR only; null for others).

    • created_atstringrequired
    • updated_atstringrequired
  • totalintegerrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/courses.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"first","archived":true}'
Response
{
  "data": {
    "items": [
      {
        "id": "tc1",
        "title": "First aid",
        "provider": "Cruz Vermelha",
        "hours": 8,
        "delivery": "external",
        "validity_months": 24,
        "pt": {
          "area": "862",
          "modality": "08",
          "provider_type": "07",
          "level": "09",
          "certificate": "04"
        },
        "lms": [
          {
            "connector": "talentlms",
            "course_id": "17"
          }
        ],
        "archived": false,
        "records": 3,
        "created_at": "2026-01-05T10:00:00.000Z",
        "updated_at": "2026-01-05T10:00:00.000Z"
      }
    ],
    "total": 1
  }
}

Get a training course#

POST/v1/training/courses.getRead

One training course with its Anexo C codes in effect and, for HR, how many records it has.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_courses_get on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • course_idstringrequired

    1–100 characters.

Returns

12 fields
  • idstringrequired
  • titlestringrequired
  • providerstring | nullrequired
  • hoursnumberrequired
  • delivery"internal" | "external"required
  • validity_monthsinteger | nullrequired
  • ptobjectrequired

    Anexo C codes: the course's own, else Settings → Training defaults (Portugal).

    5 fields
    • areastring | nullrequired
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • lmsobject[]required

    Learning tool courses that are this course: a completion there adds a record.

    2 fields
    • connectorstringrequired
    • course_idstringrequired
  • archivedbooleanrequired
  • recordsinteger | nullrequired

    Records from this course (HR only; null for others).

  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/courses.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_id":"tc1"}'
Response
{
  "data": {
    "id": "tc1",
    "title": "First aid",
    "provider": "Cruz Vermelha",
    "hours": 8,
    "delivery": "external",
    "validity_months": 24,
    "pt": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "lms": [
      {
        "connector": "talentlms",
        "course_id": "17"
      }
    ],
    "archived": false,
    "records": 3,
    "created_at": "2026-01-05T10:00:00.000Z",
    "updated_at": "2026-01-05T10:00:00.000Z"
  }
}

Add a training course#

POST/v1/training/courses.createWrite

Adds a course: title, hours, and optionally provider, delivery (internal by default), validity_months (certificates expire), pt (Portugal's Anexo C codes: an area from table 30; the rest default to Settings → Training: modality 08, the company itself, attendance certificate, no level) and lms (learning tool courses that are this course; each maps to one course). Up to 2000 courses. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_courses_create on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • titlestringrequired

    What people call it, e.g. "First aid" or "Excel for finance".

    1–160 characters.

  • providerstring | null

    Who gives it (a training company, a school); leave out for your own.

    Up to 160 characters.

  • hoursnumberrequired

    Hours of the course (a record from it starts with these).

    From 0 to 2000.

  • delivery"internal" | "external"

    internal (default: the company gives it) or external.

  • validity_monthsinteger | null

    Certificates from it expire this many months after the last day (e.g. 24 for first aid); null: never.

    From 1 to 240.

  • ptobject

    Portugal, Anexo C codes; only the area has no default (Settings → Training).

    5 fields
    • areastring | null

      Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

  • lmsobject[]

    Learning tool courses that are this course (connector talentlms, learning360, docebo or moodle, and the tool's course id): a completion there adds a record with this course's hours.

    Up to 10 items.

    2 fields
    • connectorstringrequired

      1–50 characters.

    • course_idstringrequired

      1–200 characters.

Returns

12 fields
  • idstringrequired
  • titlestringrequired
  • providerstring | nullrequired
  • hoursnumberrequired
  • delivery"internal" | "external"required
  • validity_monthsinteger | nullrequired
  • ptobjectrequired

    Anexo C codes: the course's own, else Settings → Training defaults (Portugal).

    5 fields
    • areastring | nullrequired
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • lmsobject[]required

    Learning tool courses that are this course: a completion there adds a record.

    2 fields
    • connectorstringrequired
    • course_idstringrequired
  • archivedbooleanrequired
  • recordsinteger | nullrequired

    Records from this course (HR only; null for others).

  • 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/courses.create \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "title": "First aid",
  "hours": 8,
  "provider": "Cruz Vermelha",
  "delivery": "external",
  "validity_months": 24,
  "pt": {
    "area": "862",
    "provider_type": "07",
    "certificate": "04"
  },
  "lms": [
    {
      "connector": "talentlms",
      "course_id": "17"
    }
  ]
}'
Response
{
  "data": {
    "id": "tc1",
    "title": "First aid",
    "provider": "Cruz Vermelha",
    "hours": 8,
    "delivery": "external",
    "validity_months": 24,
    "pt": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "lms": [
      {
        "connector": "talentlms",
        "course_id": "17"
      }
    ],
    "archived": false,
    "records": 0,
    "created_at": "2026-01-05T10:00:00.000Z",
    "updated_at": "2026-01-05T10:00:00.000Z"
  }
}

Change a training course#

POST/v1/training/courses.updateWrite

Changes a course's title, provider, hours, delivery, validity_months, pt codes (send the codes to change; null area clears it) or lms mapping (replaces the list). Records already made keep their hours and expiry dates. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_courses_update on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • titlestring

    What people call it, e.g. "First aid" or "Excel for finance".

    1–160 characters.

  • providerstring | null

    Who gives it (a training company, a school); leave out for your own.

    Up to 160 characters.

  • hoursnumber

    Hours of the course (a record from it starts with these).

    From 0 to 2000.

  • delivery"internal" | "external"

    internal (default: the company gives it) or external.

  • validity_monthsinteger | null

    Certificates from it expire this many months after the last day (e.g. 24 for first aid); null: never.

    From 1 to 240.

  • ptobject

    Portugal, Anexo C codes; only the area has no default (Settings → Training).

    5 fields
    • areastring | null

      Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

  • lmsobject[]

    Learning tool courses that are this course (connector talentlms, learning360, docebo or moodle, and the tool's course id): a completion there adds a record with this course's hours.

    Up to 10 items.

    2 fields
    • connectorstringrequired

      1–50 characters.

    • course_idstringrequired

      1–200 characters.

  • course_idstringrequired

    1–100 characters.

Returns

12 fields
  • idstringrequired
  • titlestringrequired
  • providerstring | nullrequired
  • hoursnumberrequired
  • delivery"internal" | "external"required
  • validity_monthsinteger | nullrequired
  • ptobjectrequired

    Anexo C codes: the course's own, else Settings → Training defaults (Portugal).

    5 fields
    • areastring | nullrequired
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • lmsobject[]required

    Learning tool courses that are this course: a completion there adds a record.

    2 fields
    • connectorstringrequired
    • course_idstringrequired
  • archivedbooleanrequired
  • recordsinteger | nullrequired

    Records from this course (HR only; null for others).

  • 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/courses.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "course_id": "tc1",
  "title": "First aid (refresh)",
  "provider": null,
  "validity_months": null,
  "pt": {
    "area": null
  },
  "lms": []
}'
Response
{
  "data": {
    "id": "tc1",
    "title": "First aid (refresh)",
    "provider": null,
    "hours": 8,
    "delivery": "external",
    "validity_months": null,
    "pt": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "lms": [
      {
        "connector": "talentlms",
        "course_id": "17"
      }
    ],
    "archived": false,
    "records": 3,
    "created_at": "2026-01-05T10:00:00.000Z",
    "updated_at": "2026-01-05T10:00:00.000Z"
  }
}

Archive a training course#

POST/v1/training/courses.archiveWrite

Archives a course no one takes any more (archived false brings it back). Its records stay, and keep counting; archived courses are left out of the course list and pickers. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_courses_archive on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • course_idstringrequired

    1–100 characters.

  • archivedboolean

    Default true.

Returns

12 fields
  • idstringrequired
  • titlestringrequired
  • providerstring | nullrequired
  • hoursnumberrequired
  • delivery"internal" | "external"required
  • validity_monthsinteger | nullrequired
  • ptobjectrequired

    Anexo C codes: the course's own, else Settings → Training defaults (Portugal).

    5 fields
    • areastring | nullrequired
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • lmsobject[]required

    Learning tool courses that are this course: a completion there adds a record.

    2 fields
    • connectorstringrequired
    • course_idstringrequired
  • archivedbooleanrequired
  • recordsinteger | nullrequired

    Records from this course (HR only; null for others).

  • 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/courses.archive \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"course_id":"tc1","archived":false}'
Response
{
  "data": {
    "id": "tc1",
    "title": "First aid",
    "provider": "Cruz Vermelha",
    "hours": 8,
    "delivery": "external",
    "validity_months": 24,
    "pt": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "lms": [
      {
        "connector": "talentlms",
        "course_id": "17"
      }
    ],
    "archived": false,
    "records": 3,
    "created_at": "2026-01-05T10:00:00.000Z",
    "updated_at": "2026-01-05T10:00:00.000Z"
  }
}

List training records#

POST/v1/training/records.listRead

Training records, newest last day first: owners, admins and HR see everyone's, with certificates and the Anexo C codes in effect; managers see the records of the people who report to them (no certificates or decline reasons); everyone else their own. Filters: person_id, course_id, year (of the last day), status (confirmed, pending: reported by the person and waiting for HR, declined), source (manual, csv, lms, self). API keys and AI apps never get certificates or decline reasons.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
Keys and apps
Never certificates or the reasons HR declined a report.
MCP tool
training_records_list on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • person_idstring

    1–100 characters.

  • course_idstring

    1–100 characters.

  • yearinteger

    From 2000 to 2100.

  • status"confirmed" | "pending" | "declined"
  • source"manual" | "csv" | "lms" | "self"
  • limitinteger

    Default 1000.

    From 1 to 5000.

Returns

  • itemsobject[]required
    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
  • totalintegerrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/records.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "person_id": "p2",
  "course_id": "tc1",
  "year": 2026,
  "status": "pending",
  "source": "self",
  "limit": 100
}'
Response
{
  "data": {
    "items": [
      {
        "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": {
          "area": "862",
          "modality": "08",
          "provider_type": "07",
          "level": "09",
          "certificate": "04"
        },
        "source": "manual",
        "status": "confirmed",
        "counts": true,
        "decline_reason": null,
        "access": "full",
        "created_at": "2026-03-04T10:00:00.000Z",
        "updated_at": "2026-03-04T10:00:00.000Z"
      }
    ],
    "total": 1
  }
}

Get a training record#

POST/v1/training/records.getRead

One training record, shaped by who asks (as training_records_list): API keys and AI apps never get its certificate or a decline reason.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
Keys and apps
Never certificates or the reasons HR declined a report.
MCP tool
training_records_get on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • record_idstringrequired

    1–100 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 module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/records.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"record_id":"tr1"}'
Response
{
  "data": {
    "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": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "source": "manual",
    "status": "confirmed",
    "counts": true,
    "decline_reason": null,
    "access": "full",
    "created_at": "2026-03-04T10:00:00.000Z",
    "updated_at": "2026-03-04T10:00:00.000Z"
  }
}

Add a training record#

POST/v1/training/records.createWrite

Records training a person did: a course (course_id), a new course made on the way (new_course), or a one-off training (title); start, end (not in the future), hours attended (default: the course's), schedule, result, kind (student_worker for student-worker hours), initiative (worker_credit for training under the worker's training credit), expires_on (default from the course's validity) and, in the app, a certificate. It counts at once (confirmed). Up to 50,000 records a year per company. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_create on HR Assistant
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.

  • result"completed" | "attended" | "failed"

    completed (default), attended (attendance only) or failed (does not count).

  • 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).

  • expires_onstring | null

    When the certificate expires (default: from the course's validity).

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

  • ptobject

    Portugal, Anexo C codes for a one-off training (a course's codes apply otherwise).

    5 fields
    • areastring | null

      Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

  • certificate_file_idstring

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

    1–64 characters.

  • person_idstringrequired

    1–100 characters.

  • new_courseobject

    Creates this course first and records it (the first course made inline).

    7 fields
    • titlestringrequired

      What people call it, e.g. "First aid" or "Excel for finance".

      1–160 characters.

    • providerstring | null

      Who gives it (a training company, a school); leave out for your own.

      Up to 160 characters.

    • hoursnumberrequired

      Hours of the course (a record from it starts with these).

      From 0 to 2000.

    • delivery"internal" | "external"

      internal (default: the company gives it) or external.

    • validity_monthsinteger | null

      Certificates from it expire this many months after the last day (e.g. 24 for first aid); null: never.

      From 1 to 240.

    • ptobject

      Portugal, Anexo C codes; only the area has no default (Settings → Training).

      5 fields
      • areastring | null

        Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

      • modalitystring

        Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

      • provider_typestring

        Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

      • levelstring

        Nível de qualificação, table 36; default 09 (no level).

      • certificatestring

        Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

    • lmsobject[]

      Learning tool courses that are this course (connector talentlms, learning360, docebo or moodle, and the tool's course id): a completion there adds a record with this course's hours.

      Up to 10 items.

      2 fields
      • connectorstringrequired

        1–50 characters.

      • course_idstringrequired

        1–200 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/records.create \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "person_id": "p2",
  "title": "English B2",
  "provider": "British Council",
  "start": "2026-01-12",
  "end": "2026-06-29",
  "hours": 40,
  "schedule": "outside",
  "result": "attended",
  "kind": "training",
  "initiative": "worker_credit",
  "expires_on": null,
  "pt": {
    "area": "222",
    "provider_type": "06"
  },
  "certificate_file_id": "f1"
}'
Response
{
  "data": {
    "id": "tr1",
    "person": {
      "id": "p2",
      "name": "Tomás Silva"
    },
    "course": {
      "id": "tc1",
      "title": "First aid"
    },
    "title": "English B2",
    "provider": "British Council",
    "start": "2026-01-12",
    "end": "2026-06-29",
    "hours": 40,
    "schedule": "outside",
    "result": "attended",
    "kind": "training",
    "initiative": "worker_credit",
    "expires_on": null,
    "certificate": {
      "name": "first-aid.pdf",
      "content_type": "application/pdf",
      "size": 182000
    },
    "has_certificate": true,
    "pt": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "source": "manual",
    "status": "confirmed",
    "counts": true,
    "decline_reason": null,
    "access": "full",
    "created_at": "2026-03-04T10:00:00.000Z",
    "updated_at": "2026-03-04T10:00:00.000Z"
  }
}

Change a training record#

POST/v1/training/records.updateWrite

Changes a record's course, title, provider, dates, hours, schedule, result, kind, initiative, expiry, codes or certificate (a new one replaces the old; certificate_file_id null removes it). The person stays the same. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_update on HR Assistant
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.

  • startstring

    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.

  • result"completed" | "attended" | "failed"

    completed (default), attended (attendance only) or failed (does not count).

  • 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).

  • expires_onstring | null

    When the certificate expires (default: from the course's validity).

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

  • ptobject

    Portugal, Anexo C codes for a one-off training (a course's codes apply otherwise).

    5 fields
    • areastring | null

      Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

  • certificate_file_idstring | null

    1–64 characters.

  • record_idstringrequired

    1–100 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/records.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "record_id": "tr1",
  "course_id": null,
  "title": "Excel",
  "certificate_file_id": null
}'
Response
{
  "data": {
    "id": "tr1",
    "person": {
      "id": "p2",
      "name": "Tomás Silva"
    },
    "course": {
      "id": "tc1",
      "title": "First aid"
    },
    "title": "Excel",
    "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": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "source": "manual",
    "status": "confirmed",
    "counts": true,
    "decline_reason": null,
    "access": "full",
    "created_at": "2026-03-04T10:00:00.000Z",
    "updated_at": "2026-03-04T10:00:00.000Z"
  }
}

Delete a training record#

POST/v1/training/records.deleteDestructive

Deletes a record entered by mistake, with its certificate. It no longer counts toward the person's hours. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_delete on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • record_idstringrequired

    1–100 characters.

Returns

  • idstringrequired
  • deletedtruerequired
  • person_idstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/records.delete \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"record_id":"tr1"}'
Response
{
  "data": {
    "id": "tr1",
    "deleted": true,
    "person_id": "p2"
  }
}

Confirm a reported training#

POST/v1/training/records.confirmWrite

Confirms training a person reported themselves (status pending): it counts from now. Confirming attests that the training relates to their job (Portugal, art. 133: IT, health and safety and languages always do). Optionally link it to a course (course_id), or correct the hours or the Anexo C codes. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_confirm on HR Assistant
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

  • record_idstringrequired

    1–100 characters.

  • course_idstring

    1–100 characters.

  • hoursnumber

    From 0 to 2000.

  • ptobject
    5 fields
    • areastring | null

      Área de educação/formação, Relatório Único table 30 (3-digit CNAEF), e.g. 481 Ciências informáticas, 862 Segurança e higiene no trabalho, 222 Línguas e literaturas estrangeiras.

    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

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/records.confirm \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"record_id":"tr1","course_id":"tc1","hours":7.5,"pt":{"area":"481"}}'
Response
{
  "data": {
    "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": 7.5,
    "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": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "source": "manual",
    "status": "confirmed",
    "counts": true,
    "decline_reason": null,
    "access": "full",
    "created_at": "2026-03-04T10:00:00.000Z",
    "updated_at": "2026-03-04T10:00:00.000Z"
  }
}

Decline a reported training#

POST/v1/training/records.declineWrite

Declines training a person reported (status pending), with the reason: the person sees it on their record (private: never managers or machines). It does not count. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_decline on HR Assistant
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

  • record_idstringrequired

    1–100 characters.

  • reasonstringrequired

    Told to the person, e.g. "Not related to your job" or "Please add the certificate".

    1–500 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/records.decline \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"record_id":"tr1","reason":"Not related to your job"}'
Response
{
  "data": {
    "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": {
      "area": "862",
      "modality": "08",
      "provider_type": "07",
      "level": "09",
      "certificate": "04"
    },
    "source": "self",
    "status": "declined",
    "counts": false,
    "decline_reason": "Not related to your job",
    "access": "full",
    "created_at": "2026-03-04T10:00:00.000Z",
    "updated_at": "2026-03-04T10:00:00.000Z"
  }
}

Import training records#

POST/v1/training/records.importWrite

Adds up to 150 training records at once (from a spreadsheet: one row per person and training). Columns: work_email, course (an existing course's title, any case) or title (one-off), provider, start and end (YYYY-MM-DD), hours (default: the course's), schedule (working, outside, mixed), result (completed, attended, failed), kind (training, student_worker), initiative (employer, worker_credit), area (Portugal, table 30, for one-off trainings). They count at once. All or nothing: run it as a dry run first to see each row's outcome; the real run refuses if any row has a problem. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_import on HR Assistant
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

  • rowsobject[]required

    1–150 items.

    12 fields
    • work_emailstringrequired

      1–254 characters.

    • coursestring | null

      A course's title (any case), or leave empty with title.

      Up to 160 characters.

    • titlestring | null

      Up to 160 characters.

    • providerstring | null

      Up to 160 characters.

    • startstringrequired

      Up to 20 characters.

    • endstring | null

      Up to 20 characters.

    • hoursnumber | string
    • schedulestring | null

      Up to 20 characters.

    • resultstring | null

      Up to 20 characters.

    • kindstring | null

      Up to 20 characters.

    • initiativestring | null

      Up to 20 characters.

    • areastring | null

      Up to 10 characters.

Returns

  • createdintegerrequired
  • rowsobject[]required
    5 fields
    • rowintegerrequired

      1 = the first data row.

    • okbooleanrequired
    • problemstring | nullrequired
    • record_idstring | nullrequired
    • warningstring | nullrequired

      Imported anyway, but worth a look: the same person already has this training on the same days.

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/records.import \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "rows": [
    {
      "work_email": "tomas@acme.test",
      "course": "First aid",
      "start": "2026-03-02"
    },
    {
      "work_email": "rita@acme.test",
      "title": "English",
      "start": "2026-01-12",
      "end": "2026-06-29",
      "hours": "40,5",
      "schedule": "outside",
      "result": "attended",
      "kind": "training",
      "initiative": "employer",
      "area": "222",
      "provider": null
    }
  ]
}'
Response
{
  "data": {
    "created": 1,
    "rows": [
      {
        "row": 1,
        "ok": true,
        "problem": null,
        "record_id": "tr2",
        "warning": null
      }
    ]
  }
}

Training hours of a person#

POST/v1/training/balance.getRead

A person's training-hour balance where their country has a training rule (Portugal: 40 hours a year; fixed-term contracts of 3 months or more a share by months; brought forward or deferred by up to 2 years, oldest year first; hours not given by then become a training credit, lapsing 3 years later): this year's hours owed, given and open, each year, credits, and — owners, admins and HR only, once a last day is set — the hours to pay on termination (art. 134). The person sees their own in My profile (training_me_list); managers see their reports' as if no last day were set until it is announced. country null: no rule, only the register. Owners, admins, HR and managers.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_balance_get on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • person_idstringrequired

    1–100 characters.

Returns

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.

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/balance.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"p2"}'
Response
{
  "data": {
    "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": {
      "last_day": "2026-12-15",
      "open_hours": 42,
      "credit_hours": 0,
      "hours": 42,
      "law": "Código do Trabalho art. 134: on termination the worker is paid for the year's training hours not given and the training credit they hold."
    }
  }
}

Training hours of the company#

POST/v1/training/balance.summaryRead

For a year (default this one), everyone with a training rule employed in it (Portugal): hours owed, given and still open, credit held, whether they are below their hours, their team, and the company totals: people, people trained, the share trained against the legal minimum (Portugal: at least 10% of workers each year, art. 131 n.º 5), people below their hours and hours open. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_balance_summary on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • yearinteger

    From 2000 to 2100.

Returns

  • yearintegerrequired
  • as_ofstringrequired
  • count_fromintegerrequired
  • peopleobject[]required
    11 fields
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • teamobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • countrystringrequired
    • owednumberrequired
    • givennumberrequired
    • opennumberrequired
    • becomes_credit_onstring | nullrequired

      Hours of the year still open that day become a training credit; null when none are open.

    • credit_heldnumberrequired
    • credit_lapses_onstring | nullrequired

      When the oldest credit held lapses; null without credit.

    • belowbooleanrequired
    • trainedbooleanrequired

      At least one training that counts in the year.

  • totalsobjectrequired
    6 fields
    • peopleintegerrequired
    • trainedintegerrequired
    • trained_sharenumberrequired
    • min_sharenumber | nullrequired
    • belowintegerrequired
    • open_hoursnumberrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/balance.summary \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"year":2025}'
Response
{
  "data": {
    "year": 2025,
    "as_of": "2026-11-12",
    "count_from": 2024,
    "people": [
      {
        "person": {
          "id": "p2",
          "name": "Tomás Silva"
        },
        "team": {
          "id": "u1",
          "name": "Engineering"
        },
        "country": "PT",
        "owed": 40,
        "given": 14,
        "open": 26,
        "becomes_credit_on": "2028-12-31",
        "credit_held": 0,
        "credit_lapses_on": null,
        "below": true,
        "trained": true
      }
    ],
    "totals": {
      "people": 1,
      "trained": 1,
      "trained_share": 1,
      "min_share": 0.1,
      "below": 1,
      "open_hours": 26
    }
  }
}

Training settings#

POST/v1/training/settings.getRead

Settings → Training: the year Bizisy counts training hours from, and the Anexo C code defaults for courses (Portugal). Owners, admins, HR and managers read them.

Who can call it
Manage key owner admin hr
MCP tool
training_settings_get on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • count_fromintegerrequired

    Years before it are taken as met (you counted training elsewhere): no hours owed, no credit.

  • pt_defaultsobjectrequired

    Portugal: Anexo C codes a course has unless it sets its own.

    4 fields
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • savedbooleanrequired

    false: the defaults (count_from this year), saved on the first course or record.

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/settings.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "count_from": 2024,
    "pt_defaults": {
      "modality": "08",
      "provider_type": "01",
      "level": "09",
      "certificate": "06"
    },
    "saved": true
  }
}

Change the training settings#

POST/v1/training/settings.updateWrite

Changes the year Bizisy counts training hours from (count_from: years before it are taken as met; set it earlier and import past records to see older balances and credits) and the Anexo C code defaults for courses (Portugal: modality, provider_type, level, certificate). Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_settings_update on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • count_frominteger

    From 2000 to 2100.

  • pt_defaultsobject
    4 fields
    • modalitystring

      Modalidade, table 31; default 08 (other continuous training outside the national catalogue).

    • provider_typestring

      Entidade formadora, table 34; default 01 (the company itself), 07 a training company, 06 a school.

    • levelstring

      Nível de qualificação, table 36; default 09 (no level).

    • certificatestring

      Tipo de certificado, table 35; default 06 (attendance certificate), 04 uncertified training certificate, 03 certified.

Returns

  • count_fromintegerrequired

    Years before it are taken as met (you counted training elsewhere): no hours owed, no credit.

  • pt_defaultsobjectrequired

    Portugal: Anexo C codes a course has unless it sets its own.

    4 fields
    • modalitystringrequired
    • provider_typestringrequired
    • levelstringrequired
    • certificatestringrequired
  • savedbooleanrequired

    false: the defaults (count_from this year), saved on the first course or record.

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/settings.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "pt_defaults": {
    "modality": "08",
    "provider_type": "01",
    "level": "09",
    "certificate": "06"
  }
}'
Response
{
  "data": {
    "count_from": 2024,
    "pt_defaults": {
      "modality": "08",
      "provider_type": "01",
      "level": "09",
      "certificate": "06"
    },
    "saved": true
  }
}

Start uploading a training certificate#

POST/v1/training/certificates.uploadWrite

Step 1 of 2 to add a certificate to a training record: send the file's name, size (at most 10 MB), content_type (application/pdf, image/png, image/jpeg or image/webp) and sha256 (lowercase hex). PUT the bytes to upload.url with exactly upload.headers within 15 minutes, then send the file_id as certificate_file_id to training_records_create, training_records_update or training_me_report. The type is checked from the bytes. Owners, admins and HR for anyone; everyone else for their own reports (counted in their own upload limits). In the app only.

Web app only
Refused for API keys and connected apps. Certificates are uploaded in the app.
MCP tool
training_certificates_upload on HR Assistant, 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

  • namestringrequired

    1–200 characters.

  • sizeintegerrequired

    From 0 to 10000000.

  • content_type"application/pdf" | "image/png" | "image/jpeg" | "image/webp"required
  • sha256stringrequired

    Pattern ^[0-9a-f]{64}$.

Returns

  • file_idstringrequired
  • uploadobject | nullrequired

    null on a dry run.

    4 fields
    • urlstringrequired
    • method"PUT"required
    • headersobjectrequired
    • resumablefalserequired
  • expires_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/certificates.upload \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "first-aid.pdf",
  "size": 182000,
  "content_type": "application/pdf",
  "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}'
Response
{
  "data": {
    "file_id": "f1",
    "upload": {
      "url": "https://storage.example/upload",
      "method": "PUT",
      "headers": {
        "content-type": "application/pdf"
      },
      "resumable": false
    },
    "expires_at": "2026-11-12T10:15:00.000Z"
  }
}

Download a training certificate#

POST/v1/training/certificates.downloadRead

A short-lived link (5 minutes) to a training record's certificate: the person themself and owners, admins and HR, in the app only (certificates are private: never managers, API keys or AI apps).

Web app only
Refused for API keys and connected apps. Certificates are private: they are downloaded in the app.
MCP tool
training_certificates_download on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • record_idstringrequired

    1–100 characters.

Returns

  • urlstringrequired
  • expires_atstringrequired
  • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/certificates.download \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"record_id":"tr1"}'
Response
{
  "data": {
    "url": "https://storage.example/download",
    "expires_at": "2026-11-12T10:05:00.000Z",
    "name": "first-aid.pdf"
  }
}

Find a course in the content library#

POST/v1/training/content.searchRead

Searches the company's connected content library (LinkedIn Learning) for courses: text, a skill name, a language code (en, pt, es…), curated (only the company's curated content). Returns each course's title, length in minutes, level, languages, skills and the link that opens it (single sign-on when set up), 20 at a time (cursor: next). connected false when the library is not connected (then no items). Anyone with training access may search (paced: 20 searches a minute per person; the same search is answered from memory for a few minutes); opening a course records nothing until the library's daily report shows activity.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_content_search on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • connector"linkedin_learning"

    The content library: linkedin_learning (the only one today).

    Default "linkedin_learning".

  • textstring

    Up to 100 characters.

  • skillstring

    Up to 100 characters.

  • languagestring

    Pattern ^[a-z]{2}$.

  • curatedboolean
  • cursorstring

    Pattern ^\d{1,6}$.

  • limitinteger

    From 1 to 50.

Returns

  • connectedbooleanrequired
  • itemsobject[]required
    10 fields
    • idstringrequired

      The library's id of the course (LinkedIn: its URN).

    • kind"course" | "video" | "path" | "other"required
    • titlestringrequired
    • descriptionstring | nullrequired
    • minutesinteger | nullrequired

      Time to complete, in minutes.

    • level"beginner" | "intermediate" | "advanced"required
    • languagesstring[]required

      Language codes it is available in.

    • skillsstring[]required

      The library's skills for it.

    • curatedbooleanrequired

      In the company's curated content.

    • launch_urlstring | nullrequired

      Where a person opens it: the single sign-on link when the company set its account id, else the course's address.

  • nextstring | nullrequired
  • totalinteger | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/content.search \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "connector": "linkedin_learning",
  "text": "excel",
  "skill": "Microsoft Excel",
  "language": "pt",
  "curated": true,
  "cursor": "20",
  "limit": 10
}'
Response
{
  "data": {
    "connected": true,
    "items": [
      {
        "id": "urn:li:lyndaCourse:100",
        "kind": "course",
        "title": "Excel Essential Training",
        "description": "Learn Excel from the ground up.",
        "minutes": 123,
        "level": "beginner",
        "languages": [
          "en",
          "pt"
        ],
        "skills": [
          "Microsoft Excel"
        ],
        "curated": false,
        "launch_url": "https://www.linkedin.com/checkpoint/enterprise/login/777?application=learning&redirect=https%3A%2F%2Fwww.linkedin.com%2Flearning%2Fexcel-essential-training&u=777"
      }
    ],
    "next": "20",
    "total": 42
  }
}

Assign a course from the content library#

POST/v1/training/content.assignWrite

Assigns a content library course (item_id from training_content_search) to people (person_ids, up to 200) or a saved group (group_id), due on due_date (default 28 days from today). Each person gets a task "Complete <course>" in My tasks with the course's link (single sign-on when set up); it ticks itself when the library's daily report shows the course completed, and the training register records it with the course's hours. The first assignment of a course makes its Bizisy course (provider, hours rounded up to the quarter hour; HR can change them). People who already have it open, or who left, are skipped and listed. Owners, admins and HR assign to anyone; managers to the people who report to them. Use dry_run first.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_content_assign on HR Assistant, 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

  • connector"linkedin_learning"

    The content library: linkedin_learning (the only one today).

    Default "linkedin_learning".

  • item_idstringrequired

    1–300 characters.

  • person_idsstring[]

    1–100 characters. 1–200 items.

  • group_idstring

    1–100 characters.

  • due_datestring

    YYYY-MM-DD, today or later (default: 28 days from today).

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

  • notestring | null

    Shown on the task instead of the default words.

    Up to 1000 characters.

Returns

  • itemobjectrequired
    3 fields
    • idstringrequired
    • titlestringrequired
    • launch_urlstring | nullrequired
  • course_idstringrequired

    The Bizisy course completions are recorded under.

  • due_datestringrequired
  • assignedobject[]required
    3 fields
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • run_idstringrequired
    • task_idstringrequired
  • skippedobject[]required
    2 fields
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • reason"already_assigned" | "left" | "not_found"required

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/content.assign \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "connector": "linkedin_learning",
  "item_id": "urn:li:lyndaCourse:100",
  "group_id": "g1",
  "due_date": "2026-12-10",
  "note": "Before the budget season."
}'
Response
{
  "data": {
    "item": {
      "id": "urn:li:lyndaCourse:100",
      "title": "Excel Essential Training",
      "launch_url": "https://www.linkedin.com/checkpoint/enterprise/login/777?application=learning&redirect=https%3A%2F%2Fwww.linkedin.com%2Flearning%2Fexcel-essential-training&u=777"
    },
    "course_id": "tc2",
    "due_date": "2026-12-10",
    "assigned": [
      {
        "person": {
          "id": "p2",
          "name": "Tomás Silva"
        },
        "run_id": "r1",
        "task_id": "t1"
      }
    ],
    "skipped": [
      {
        "person": {
          "id": "p3",
          "name": "Rita Costa"
        },
        "reason": "already_assigned"
      }
    ]
  }
}

Confirm all completions from learning tools#

POST/v1/training/records.confirm_allWrite

Confirms, at once, every training record waiting for HR that came from a learning tool (source lms: courses people completed in LinkedIn Learning that nobody assigned), up to 150 at a time: they count from now. Confirming attests that the training relates to their job (Portugal, art. 133). Your own are left for someone else. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_records_confirm_all on HR Assistant
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

No input: send {}.

Returns

  • confirmedintegerrequired
  • leftintegerrequired

    Still waiting (more than 150, or your own).

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/records.confirm_all \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Response
{
  "data": {
    "confirmed": 3,
    "left": 0
  }
}

List mandatory training rules#

POST/v1/training/rules.listRead

The company's mandatory training rules: the course, who it applies to (titles, teams and the teams under them, locations, legal entities; none: everyone), when it is due (within N days of starting or of joining the group, or by a date), the renewal, and how many people it applies to today with their status (overdue, due_soon within 30 days, due, done, exempt) and the share done. Archived rules only with archived true. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_rules_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • archivedboolean

    true: only archived rules.

Returns

  • itemsobject[]required
    15 fields
    • idstringrequired
    • courseobjectrequired
      4 fields
      • idstringrequired
      • titlestringrequired
      • archivedbooleanrequired
      • validity_monthsinteger | nullrequired
    • whoobjectrequired

      Empty lists everywhere: everyone.

      4 fields
      • titlesobject[]required
        2 fields
        • idstringrequired
        • namestringrequired
      • unitsobject[]required
        2 fields
        • idstringrequired
        • namestringrequired
      • locationsobject[]required
        2 fields
        • idstringrequired
        • namestringrequired
      • legal_entitiesobject[]required
        2 fields
        • idstringrequired
        • namestringrequired
    • due_from"start" | "joined" | "date"required
    • daysintegerrequired
    • datestring | nullrequired
    • renewal"none" | "certificate" | "months"required
    • renew_monthsinteger | nullrequired
    • applies_fromstringrequired

      The day the rule was made: people already there get the same days from it.

    • archivedbooleanrequired
    • peopleintegerrequired

      People it applies to today.

    • countsobjectrequired

      Their assignments by status today.

      5 fields
      • overdueintegerrequired
      • due_soonintegerrequired
      • dueintegerrequired
      • doneintegerrequired
      • exemptintegerrequired
    • compliancenumber | nullrequired

      Done ÷ (people − exempt), 0–1; null when it applies to no one.

    • created_atstringrequired
    • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/rules.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"archived":true}'
Response
{
  "data": {
    "items": [
      {
        "id": "rl1",
        "course": {
          "id": "tc1",
          "title": "First aid",
          "archived": false,
          "validity_months": 24
        },
        "who": {
          "titles": [],
          "units": [
            {
              "id": "u1",
              "name": "Operations"
            }
          ],
          "locations": [
            {
              "id": "l1",
              "name": "Lisbon"
            }
          ],
          "legal_entities": []
        },
        "due_from": "start",
        "days": 30,
        "date": null,
        "renewal": "certificate",
        "renew_months": null,
        "applies_from": "2026-11-12",
        "archived": false,
        "people": 13,
        "counts": {
          "overdue": 1,
          "due_soon": 2,
          "due": 0,
          "done": 9,
          "exempt": 1
        },
        "compliance": 0.75,
        "created_at": "2026-11-12T10:00:00.000Z",
        "updated_at": "2026-11-12T10:00:00.000Z"
      }
    ]
  }
}

Add a mandatory training rule#

POST/v1/training/rules.createWrite

Makes a course mandatory: course_id, who (titles, teams, locations, legal entities; none: everyone), due_from (start: within days of the first day, default 30; joined: within days of joining the group; date: by a date, late joiners within days), renewal (none, certificate: when the certificate expires, the default for a course with a validity; months: every renew_months). People already here get the same days from today, so nobody is overdue the day it is made. Use dry_run first: the result says how many people it applies to and their status. Up to 200 rules. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_rules_create on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • course_idstringrequired

    The course people must complete (training_courses_list).

    1–100 characters.

  • whoobject

    Who it applies to: people matching every list you send (any value within a list). Leave out (or send empty lists) for everyone.

    4 fields
    • title_idsstring[]

      Job titles (org_titles_list ids): people with one of them.

      1–100 characters. Up to 100 items.

    • unit_idsstring[]

      Teams (org_units_list ids): people in one of them or a team under it.

      1–100 characters. Up to 100 items.

    • location_idsstring[]

      Work locations (org_locations_list ids).

      1–100 characters. Up to 100 items.

    • legal_entity_idsstring[]

      Legal entities (org_entities_list ids).

      1–100 characters. Up to 100 items.

  • due_from"start" | "joined" | "date"

    start (default): within `days` of their first day; joined: within `days` of joining the group the rule names (team, title, location or entity; their first day for everyone); date: by `date`, and people who join after it within `days`.

  • daysinteger

    Days to complete it (default 30; date rules: days for people who join after the date, default 30).

    From 0 to 730.

  • datestring | null

    due_from date only: the day everyone must have it by.

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

  • renewal"none" | "certificate" | "months"

    none: once is enough; certificate: again when the certificate expires (the course's validity; the default when the course has one); months: again every renew_months after the last completion.

  • renew_monthsinteger | null

    renewal months only.

    From 1 to 240.

Returns

15 fields
  • idstringrequired
  • courseobjectrequired
    4 fields
    • idstringrequired
    • titlestringrequired
    • archivedbooleanrequired
    • validity_monthsinteger | nullrequired
  • whoobjectrequired

    Empty lists everywhere: everyone.

    4 fields
    • titlesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • unitsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • locationsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entitiesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
  • due_from"start" | "joined" | "date"required
  • daysintegerrequired
  • datestring | nullrequired
  • renewal"none" | "certificate" | "months"required
  • renew_monthsinteger | nullrequired
  • applies_fromstringrequired

    The day the rule was made: people already there get the same days from it.

  • archivedbooleanrequired
  • peopleintegerrequired

    People it applies to today.

  • countsobjectrequired

    Their assignments by status today.

    5 fields
    • overdueintegerrequired
    • due_soonintegerrequired
    • dueintegerrequired
    • doneintegerrequired
    • exemptintegerrequired
  • compliancenumber | nullrequired

    Done ÷ (people − exempt), 0–1; null when it applies to no one.

  • 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/rules.create \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "course_id": "tc1",
  "who": {
    "title_ids": [
      "t1"
    ],
    "unit_ids": [
      "u1"
    ],
    "location_ids": [
      "l1"
    ],
    "legal_entity_ids": [
      "e1"
    ]
  },
  "due_from": "date",
  "days": 30,
  "date": "2027-03-31",
  "renewal": "months",
  "renew_months": 24
}'
Response
{
  "data": {
    "id": "rl1",
    "course": {
      "id": "tc1",
      "title": "First aid",
      "archived": false,
      "validity_months": 24
    },
    "who": {
      "titles": [],
      "units": [
        {
          "id": "u1",
          "name": "Operations"
        }
      ],
      "locations": [
        {
          "id": "l1",
          "name": "Lisbon"
        }
      ],
      "legal_entities": []
    },
    "due_from": "date",
    "days": 30,
    "date": "2027-03-31",
    "renewal": "months",
    "renew_months": 24,
    "applies_from": "2026-11-12",
    "archived": false,
    "people": 13,
    "counts": {
      "overdue": 1,
      "due_soon": 2,
      "due": 0,
      "done": 9,
      "exempt": 1
    },
    "compliance": 0.75,
    "created_at": "2026-11-12T10:00:00.000Z",
    "updated_at": "2026-11-12T10:00:00.000Z"
  }
}

Change a mandatory training rule#

POST/v1/training/rules.updateWrite

Changes a rule's course, who, due_from, days, date, renewal or renew_months (send what changes; who replaces the lists). The day it applies from stays, so people already there keep their dates. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_rules_update on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • course_idstring

    The course people must complete (training_courses_list).

    1–100 characters.

  • whoobject

    Who it applies to: people matching every list you send (any value within a list). Leave out (or send empty lists) for everyone.

    4 fields
    • title_idsstring[]

      Job titles (org_titles_list ids): people with one of them.

      1–100 characters. Up to 100 items.

    • unit_idsstring[]

      Teams (org_units_list ids): people in one of them or a team under it.

      1–100 characters. Up to 100 items.

    • location_idsstring[]

      Work locations (org_locations_list ids).

      1–100 characters. Up to 100 items.

    • legal_entity_idsstring[]

      Legal entities (org_entities_list ids).

      1–100 characters. Up to 100 items.

  • due_from"start" | "joined" | "date"

    start (default): within `days` of their first day; joined: within `days` of joining the group the rule names (team, title, location or entity; their first day for everyone); date: by `date`, and people who join after it within `days`.

  • daysinteger

    Days to complete it (default 30; date rules: days for people who join after the date, default 30).

    From 0 to 730.

  • datestring | null

    due_from date only: the day everyone must have it by.

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

  • renewal"none" | "certificate" | "months"

    none: once is enough; certificate: again when the certificate expires (the course's validity; the default when the course has one); months: again every renew_months after the last completion.

  • renew_monthsinteger | null

    renewal months only.

    From 1 to 240.

  • rule_idstringrequired

    1–100 characters.

Returns

15 fields
  • idstringrequired
  • courseobjectrequired
    4 fields
    • idstringrequired
    • titlestringrequired
    • archivedbooleanrequired
    • validity_monthsinteger | nullrequired
  • whoobjectrequired

    Empty lists everywhere: everyone.

    4 fields
    • titlesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • unitsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • locationsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entitiesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
  • due_from"start" | "joined" | "date"required
  • daysintegerrequired
  • datestring | nullrequired
  • renewal"none" | "certificate" | "months"required
  • renew_monthsinteger | nullrequired
  • applies_fromstringrequired

    The day the rule was made: people already there get the same days from it.

  • archivedbooleanrequired
  • peopleintegerrequired

    People it applies to today.

  • countsobjectrequired

    Their assignments by status today.

    5 fields
    • overdueintegerrequired
    • due_soonintegerrequired
    • dueintegerrequired
    • doneintegerrequired
    • exemptintegerrequired
  • compliancenumber | nullrequired

    Done ÷ (people − exempt), 0–1; null when it applies to no one.

  • 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/rules.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "rule_id": "rl1",
  "course_id": "tc1",
  "who": {},
  "due_from": "joined",
  "date": null,
  "renewal": "none",
  "renew_months": null
}'
Response
{
  "data": {
    "id": "rl1",
    "course": {
      "id": "tc1",
      "title": "First aid",
      "archived": false,
      "validity_months": 24
    },
    "who": {
      "titles": [],
      "units": [
        {
          "id": "u1",
          "name": "Operations"
        }
      ],
      "locations": [
        {
          "id": "l1",
          "name": "Lisbon"
        }
      ],
      "legal_entities": []
    },
    "due_from": "joined",
    "days": 30,
    "date": null,
    "renewal": "none",
    "renew_months": null,
    "applies_from": "2026-11-12",
    "archived": false,
    "people": 13,
    "counts": {
      "overdue": 1,
      "due_soon": 2,
      "due": 0,
      "done": 9,
      "exempt": 1
    },
    "compliance": 0.75,
    "created_at": "2026-11-12T10:00:00.000Z",
    "updated_at": "2026-11-12T10:00:00.000Z"
  }
}

Archive a mandatory training rule#

POST/v1/training/rules.archiveWrite

Archives a rule (archived false brings it back): it stops applying, nobody is due or overdue under it, and exemptions under it are kept. Records are not touched. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_rules_archive on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • rule_idstringrequired

    1–100 characters.

  • archivedboolean

    Default true.

Returns

15 fields
  • idstringrequired
  • courseobjectrequired
    4 fields
    • idstringrequired
    • titlestringrequired
    • archivedbooleanrequired
    • validity_monthsinteger | nullrequired
  • whoobjectrequired

    Empty lists everywhere: everyone.

    4 fields
    • titlesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • unitsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • locationsobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entitiesobject[]required
      2 fields
      • idstringrequired
      • namestringrequired
  • due_from"start" | "joined" | "date"required
  • daysintegerrequired
  • datestring | nullrequired
  • renewal"none" | "certificate" | "months"required
  • renew_monthsinteger | nullrequired
  • applies_fromstringrequired

    The day the rule was made: people already there get the same days from it.

  • archivedbooleanrequired
  • peopleintegerrequired

    People it applies to today.

  • countsobjectrequired

    Their assignments by status today.

    5 fields
    • overdueintegerrequired
    • due_soonintegerrequired
    • dueintegerrequired
    • doneintegerrequired
    • exemptintegerrequired
  • compliancenumber | nullrequired

    Done ÷ (people − exempt), 0–1; null when it applies to no one.

  • 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/rules.archive \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rule_id":"rl1","archived":false}'
Response
{
  "data": {
    "id": "rl1",
    "course": {
      "id": "tc1",
      "title": "First aid",
      "archived": false,
      "validity_months": 24
    },
    "who": {
      "titles": [],
      "units": [
        {
          "id": "u1",
          "name": "Operations"
        }
      ],
      "locations": [
        {
          "id": "l1",
          "name": "Lisbon"
        }
      ],
      "legal_entities": []
    },
    "due_from": "start",
    "days": 30,
    "date": null,
    "renewal": "certificate",
    "renew_months": null,
    "applies_from": "2026-11-12",
    "archived": false,
    "people": 0,
    "counts": {
      "overdue": 0,
      "due_soon": 0,
      "due": 0,
      "done": 0,
      "exempt": 0
    },
    "compliance": null,
    "created_at": "2026-11-12T10:00:00.000Z",
    "updated_at": "2026-11-12T10:00:00.000Z"
  }
}

Mandatory training compliance#

POST/v1/training/compliance.listRead

Who must do which mandatory training (training_rules_list) and where they stand today: overdue, due_soon (within 30 days, or a renewal within 30 days), due, done, exempt; the share done overall, by course (rule), team and location; and the people, most urgent first, filtered by rule, course, person, team, location, status or words, a page at a time (limit up to 5,000, offset). Computed on read from people, rules, records and exemptions. A completion reported but not confirmed yet shows waiting_for_hr. Owners, admins and HR see everyone (and, for one person, their exemption history); managers their reports' (no exemption reasons); others nothing. People see their own in training_me_list.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_compliance_list on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • rule_idstring

    1–100 characters.

  • course_idstring

    1–100 characters.

  • person_idstring

    1–100 characters.

  • team_idstring

    Their team (not the teams under it).

    1–100 characters.

  • location_idstring

    1–100 characters.

  • status"overdue" | "due_soon" | "due" | "done" | "exempt"[]

    Only these statuses (e.g. ["overdue"] for what needs HR now).

    Up to 5 items.

  • qstring

    Words in the person's name, team or the course.

    Up to 100 characters.

  • limitinteger

    From 1 to 5000. Default 200.

  • offsetinteger

    At least 0. Default 0.

Returns

11 fields
  • as_ofstringrequired
  • scope"company" | "reports" | "none"required

    company: owners, admins and HR; reports: a manager's reports (their whole chain); none: nobody to show.

  • rulesintegerrequired

    Active rules.

  • totalsobjectrequired
    3 fields
    • countsobjectrequired
      5 fields
      • overdueintegerrequired
      • due_soonintegerrequired
      • dueintegerrequired
      • doneintegerrequired
      • exemptintegerrequired
    • compliancenumber | nullrequired
    • peopleintegerrequired
  • by_ruleobject[]required
    5 fields
    • countsobjectrequired
      5 fields
      • overdueintegerrequired
      • due_soonintegerrequired
      • dueintegerrequired
      • doneintegerrequired
      • exemptintegerrequired
    • compliancenumber | nullrequired
    • peopleintegerrequired
    • rule_idstringrequired
    • courseobjectrequired
      2 fields
      • idstringrequired
      • titlestringrequired
  • by_teamobject[]required
    4 fields
    • countsobjectrequired
      5 fields
      • overdueintegerrequired
      • due_soonintegerrequired
      • dueintegerrequired
      • doneintegerrequired
      • exemptintegerrequired
    • compliancenumber | nullrequired
    • peopleintegerrequired
    • teamobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • by_locationobject[]required
    4 fields
    • countsobjectrequired
      5 fields
      • overdueintegerrequired
      • due_soonintegerrequired
      • dueintegerrequired
      • doneintegerrequired
      • exemptintegerrequired
    • compliancenumber | nullrequired
    • peopleintegerrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • itemsobject[]required
    14 fields
    • keystringrequired

      rule_id:person_id: stable, one per person and rule.

    • rule_idstringrequired
    • courseobjectrequired
      3 fields
      • idstringrequired
      • titlestringrequired
      • archivedbooleanrequired
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • teamobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • status"overdue" | "due_soon" | "due" | "done" | "exempt"required

      overdue: past its due date; due_soon: due within 30 days (or the completion lapses within 30 days); due: later; done; exempt.

    • due_onstring | nullrequired
    • done_onstring | nullrequired
    • valid_untilstring | nullrequired
    • waiting_for_hrbooleanrequired

      A completion of the course was reported or came from a learning tool and waits for HR to confirm it.

    • blocked"course_archived"required

      Why it can't be done yet: the course is archived (restore it).

    • exemptionobject | nullrequired
      2 fields
      • reasonstring | nullrequired

        Private: owners, admins and HR in the app; null for others.

      • sincestringrequired
    • reminded_onstring | nullrequired

      When someone last pressed Remind (owners, admins, HR and managers).

  • totalintegerrequired

    Items matching the filters (items holds one page of them).

  • next_offsetinteger | nullrequired
  • historyobject[] | nullrequired

    With person_id, owners, admins and HR in the app: every exemption of the person, ended ones too.

    5 fields
    • rule_idstringrequired
    • coursestringrequired
    • reasonstringrequired
    • sincestringrequired
    • ended_onstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/compliance.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "rule_id": "rl1",
  "course_id": "tc1",
  "person_id": "p2",
  "team_id": "u1",
  "location_id": "l1",
  "status": [
    "overdue",
    "due_soon"
  ],
  "q": "silva",
  "limit": 500,
  "offset": 500
}'
Response
{
  "data": {
    "as_of": "2026-11-12",
    "scope": "company",
    "rules": 1,
    "totals": {
      "counts": {
        "overdue": 1,
        "due_soon": 2,
        "due": 0,
        "done": 9,
        "exempt": 1
      },
      "compliance": 0.75,
      "people": 13
    },
    "by_rule": [
      {
        "rule_id": "rl1",
        "course": {
          "id": "tc1",
          "title": "First aid"
        },
        "counts": {
          "overdue": 1,
          "due_soon": 2,
          "due": 0,
          "done": 9,
          "exempt": 1
        },
        "compliance": 0.75,
        "people": 13
      }
    ],
    "by_team": [
      {
        "team": {
          "id": "u1",
          "name": "Operations"
        },
        "counts": {
          "overdue": 1,
          "due_soon": 2,
          "due": 0,
          "done": 9,
          "exempt": 1
        },
        "compliance": 0.75,
        "people": 13
      }
    ],
    "by_location": [
      {
        "location": null,
        "counts": {
          "overdue": 1,
          "due_soon": 2,
          "due": 0,
          "done": 9,
          "exempt": 1
        },
        "compliance": 0.75,
        "people": 13
      }
    ],
    "items": [
      {
        "key": "rl1:p2",
        "rule_id": "rl1",
        "course": {
          "id": "tc1",
          "title": "First aid",
          "archived": false
        },
        "person": {
          "id": "p2",
          "name": "Tomás Silva"
        },
        "team": {
          "id": "u1",
          "name": "Operations"
        },
        "location": {
          "id": "l1",
          "name": "Lisbon"
        },
        "status": "overdue",
        "due_on": "2026-11-01",
        "done_on": null,
        "valid_until": null,
        "waiting_for_hr": false,
        "blocked": null,
        "exemption": null,
        "reminded_on": "2026-11-12"
      },
      {
        "key": "rl1:p3",
        "rule_id": "rl1",
        "course": {
          "id": "tc1",
          "title": "First aid",
          "archived": false
        },
        "person": {
          "id": "p3",
          "name": "Rita Costa"
        },
        "team": {
          "id": "u1",
          "name": "Operations"
        },
        "location": {
          "id": "l1",
          "name": "Lisbon"
        },
        "status": "exempt",
        "due_on": null,
        "done_on": null,
        "valid_until": null,
        "waiting_for_hr": false,
        "blocked": null,
        "exemption": {
          "reason": "Certified elsewhere",
          "since": "2026-11-10"
        },
        "reminded_on": null
      }
    ],
    "total": 2,
    "next_offset": null,
    "history": [
      {
        "rule_id": "rl1",
        "course": "First aid",
        "reason": "Certified elsewhere",
        "since": "2026-11-10",
        "ended_on": null
      }
    ]
  }
}

Remind people of mandatory training#

POST/v1/training/compliance.remindWrite

Sends one email now to each person (person_ids, up to 200) about the mandatory training of a rule they haven't done (overdue, due soon or due), and one to their manager: the course and the due date. Once a day per person (whatever the rule); people who are done, exempt, not covered by the rule or without a work email are skipped and listed. Emails count toward the company's daily email cap. Owners, admins and HR remind anyone; managers their reports, up to 50 people a day.

Who can call it
Manage key owner admin hr
Me key owner admin hr member
MCP tool
training_compliance_remind on HR Assistant, 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

  • rule_idstringrequired

    1–100 characters.

  • person_idsstring[]required

    1–100 characters. 1–200 items.

Returns

  • sentintegerrequired

    People emailed.

  • managersintegerrequired

    Manager emails sent (one per person reminded who has a manager).

  • skippedobject[]required
    2 fields
    • person_idstringrequired
    • reason"not_due" | "reminded_today" | "not_covered" | "no_email"required

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/compliance.remind \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rule_id":"rl1","person_ids":["p2"]}'
Response
{
  "data": {
    "sent": 1,
    "managers": 1,
    "skipped": [
      {
        "person_id": "p3",
        "reason": "not_due"
      }
    ]
  }
}

Exempt someone from a mandatory training#

POST/v1/training/compliance.exemptWrite

Exempts a person from a rule, with a reason (e.g. "Holds a valid first aid certificate from a previous employer", "On long-term leave until March"): they count as exempt, not overdue. The reason is private (owners, admins and HR in the app) and kept in the person's exemption history; end it with training_compliance_unexempt. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_compliance_exempt on HR Assistant
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

  • rule_idstringrequired

    1–100 characters.

  • person_idstringrequired

    1–100 characters.

  • reasonstringrequired

    Why: kept in the history.

    3–500 characters.

Returns

  • rule_idstringrequired
  • person_idstringrequired
  • exemptbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/compliance.exempt \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rule_id":"rl1","person_id":"p3","reason":"Certified elsewhere"}'
Response
{
  "data": {
    "rule_id": "rl1",
    "person_id": "p3",
    "exempt": true
  }
}

End an exemption from a mandatory training#

POST/v1/training/compliance.unexemptWrite

Ends a person's exemption from a rule: the training is due for them again (from its usual due date). The exemption stays in their history. Owners, admins and HR.

Who can call it
Manage key owner admin hr
MCP tool
training_compliance_unexempt on HR Assistant
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

  • rule_idstringrequired

    1–100 characters.

  • person_idstringrequired

    1–100 characters.

Returns

  • rule_idstringrequired
  • person_idstringrequired
  • exemptbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/training/compliance.unexempt \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rule_id":"rl1","person_id":"p3"}'
Response
{
  "data": {
    "rule_id": "rl1",
    "person_id": "p3",
    "exempt": false
  }
}

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs