Skip to content

API reference

Employee relations

Disciplinary cases with the deadlines from the law (Portugal, Spain; the company's own periods elsewhere), the case file, case teams, evidence requests, the case assistant (AI reading of case documents) and settings. Every action works only in the Bizisy app: API keys and connected AI apps are refused, reads included, because a case is confidential to its team.

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

My access to Employee relations#

POST/v1/relations/access.meRead

Whether the caller may open new cases (ER staff), sees the register (owners and admins) and how many open cases they are on. In the app only: machines are refused.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_access_me on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • onbooleanrequired

    Employee relations shows for this login: ER staff, the register, or on a case.

  • staffbooleanrequired
  • registerbooleanrequired
  • casesintegerrequired
  • settingsbooleanrequired
  • mineobject[]required

    Your open cases, most urgent first (at most 20): ⌘K opens them by number.

    2 fields
    • idstringrequired
    • numberstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/access.me \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "on": true,
    "staff": true,
    "register": false,
    "cases": 1,
    "settings": false,
    "mine": [
      {
        "id": "c1",
        "number": "ER-2026-0001"
      }
    ]
  }
}

List employee relations cases#

POST/v1/relations/cases.listRead

Cases the caller is on (view mine), or for owners and admins the register (view register): number, person, kind, step, next deadline, team, legal hold. The register carries no facts, evidence or letters. Anyone else sees no case at all; the person a case is about never sees theirs here. Filter by status (open, closed, all), kind and a case number. In the app only: API keys and AI apps are refused.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • view"mine" | "register"

    Default "mine".

  • status"open" | "closed" | "all"

    Default "open".

  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"
  • qstring

    A case number, or part of one.

    Up to 40 characters.

Returns

  • itemsobject[]required
    14 fields
    • idstringrequired
    • numberstringrequired
    • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
    • status"open" | "closed"required
    • phasestring (enum)required

      One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

    • personobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • nextobject | nullrequired
      6 fields
      • labelstringrequired
      • basisstringrequired
      • duestringrequired
      • days_leftintegerrequired
      • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
      • lapsebooleanrequired
    • lapsedbooleanrequired
    • holdbooleanrequired
    • teamobject[]required
      4 fields
      • user_idstringrequired
      • namestringrequired
      • role"lead" | "member" | "decider" | "reviewer"required
      • via_break_glassbooleanrequired
    • my_role"lead" | "member" | "decider" | "reviewer"required

      null: a register row (owners and admins, not on the team).

    • opened_onstringrequired
    • closed_atstring | nullrequired
    • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • totalintegerrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"view":"register","status":"all"}'
Response
{
  "data": {
    "items": [
      {
        "id": "c1",
        "number": "ER-2026-0001",
        "kind": "dismissal",
        "status": "open",
        "phase": "defence",
        "person": {
          "id": "p2",
          "name": "Bea Silva"
        },
        "next": {
          "label": "Defence period",
          "basis": "CT 355(1)",
          "due": "2026-12-07",
          "days_left": 14,
          "state": "running",
          "lapse": false
        },
        "lapsed": false,
        "hold": false,
        "team": [
          {
            "user_id": "u1",
            "name": "Rui Lopes",
            "role": "lead",
            "via_break_glass": false
          }
        ],
        "my_role": "lead",
        "opened_on": "2026-11-05",
        "closed_at": null,
        "outcome": null
      }
    ],
    "total": 1
  }
}

Open an employee relations case#

POST/v1/relations/cases.getRead

The whole case for someone on its team: facts, flags, every clock with its article and what stops it, the next three deadlines, the procedure check before the written charges and before the decision, protected-situation warnings, the timeline, the case file (evidence with provenance, uploads, statements), evidence requests and, in Portugal, the count of confirmed unjustified absences. Anyone not on the team (owners, admins and HR included) gets not_found. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_get on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1"}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Open an employee relations case#

POST/v1/relations/cases.openWrite

Opens a case about an active person (ER staff only): the kind (dismissal, sanction, abandonment, inquiry), the facts as short titles with their dates and the day the employer learned of each, ticks (representative, union member, micro-enterprise, works council, parental, a recent complaint, whistleblowing) and the team (you are the lead; add a decider and others). A dry run returns the dates the rule pack computes ("Start the procedure by …", CT 329(2)), the protected-situation warnings and who on the team manages the person (they need confirm_chain). The case number ER-<year>-<seq> is the only identifier in emails and Activity. Up to 20 facts and 20 team members; 5000 open cases a company. Nobody is notified, and the person learns nothing. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_open 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

  • person_idstringrequired

    1–64 characters.

  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • factsobject[]

    Up to 20 items.

    7 fields
    • idstring

      Up to 20 characters.

    • titlestringrequired

      A one-line title in your words, e.g. "Absent without notice on 3, 4 and 5 November".

      1–160 characters.

    • datesstring[]

      The infraction dates (continued conduct: its last date).

      Up to 50 items. Pattern ^\d{4}-\d{2}-\d{2}$.

    • learned_onstring | null

      The day the employer or the superior with disciplinary power learned of it.

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

    • crimeboolean

      May also be a crime (the criminal-law period applies; never upload criminal records).

      Default false.

    • crime_untilstring | null

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

    • severity"leve" | "grave" | "muy_grave"

      Spain: the convenio severity.

      Default null.

  • flagsobject

    Default {}.

    9 fields
    • repboolean
    • unionboolean
    • candidateboolean
    • microboolean
    • councilboolean
    • parentalboolean
    • complaint_onstring | null

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

    • equality_complaintboolean
    • whistleblowerboolean
  • absent_sincestring | null

    Abandonment: the first day absent with no word.

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

  • teamobject[]

    Others on the team; you are the lead.

    Up to 20 items.

    2 fields
    • user_idstringrequired

      1–64 characters.

    • role"lead" | "member" | "decider" | "reviewer"required
  • confirm_chainboolean

    true: you saw that someone on the team manages the person.

    Default false.

Returns

7 fields
  • idstring | nullrequired
  • numberstringrequired
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • start_byobject | nullrequired
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • chainobject[]required

    Team members who manage the person: they will see the whole case.

    2 fields
    • user_idstringrequired
    • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.open \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "person_id": "p2",
  "kind": "dismissal",
  "facts": [
    {
      "title": "Absent without notice",
      "dates": [
        "2026-11-03"
      ],
      "learned_on": "2026-11-05"
    }
  ],
  "team": [
    {
      "user_id": "u2",
      "role": "decider"
    }
  ]
}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "start_by": {
      "key": "C6",
      "clock": "C6",
      "type": "wait",
      "fact_id": null,
      "label": "Defence period",
      "basis": "CT 355(1)",
      "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
      "confidence": "verified",
      "stops": "The answer received early, or an extension the team grants (recorded)",
      "if_missed": "The team may go on with the procedure.",
      "lapse": false,
      "started_on": "2026-11-20",
      "due": "2026-12-07",
      "state": "running",
      "days_left": 14,
      "note": null
    },
    "protected": [],
    "chain": []
  }
}

Change a case's facts or ticks#

POST/v1/relations/cases.updateWrite

Changes an open case's facts (titles, dates, when the employer learned, crime, severity), ticks, the first day of an abandonment absence, the My workspace options (lead only), or moves it to the newest rule set (pack_version: "current", lead only; a newer set never moves dates silently). The lead and members; the decider and reviewer only read. Recomputes every clock. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_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

  • case_idstringrequired

    1–64 characters.

  • factsobject[]

    Up to 20 items.

    7 fields
    • idstring

      Up to 20 characters.

    • titlestringrequired

      A one-line title in your words, e.g. "Absent without notice on 3, 4 and 5 November".

      1–160 characters.

    • datesstring[]

      The infraction dates (continued conduct: its last date).

      Up to 50 items. Pattern ^\d{4}-\d{2}-\d{2}$.

    • learned_onstring | null

      The day the employer or the superior with disciplinary power learned of it.

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

    • crimeboolean

      May also be a crime (the criminal-law period applies; never upload criminal records).

      Default false.

    • crime_untilstring | null

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

    • severity"leve" | "grave" | "muy_grave"

      Spain: the convenio severity.

      Default null.

  • flagsobject
    9 fields
    • repboolean
    • unionboolean
    • candidateboolean
    • microboolean
    • councilboolean
    • parentalboolean
    • complaint_onstring | null

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

    • equality_complaintboolean
    • whistleblowerboolean
  • absent_sincestring | null

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

  • meobject
    3 fields
    • lettersboolean
    • answerboolean
    • consultboolean
  • pack_version"current"

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","flags":{"council":true}}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Turn an inquiry into a dismissal or sanction case#

POST/v1/relations/cases.convertWrite

Converts an open inquiry into a dismissal or sanction case; it keeps its file, events and dates (the inquiry's interruption of the limits stays, CT 352). The lead only. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_convert 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

  • case_idstringrequired

    1–64 characters.

  • kind"dismissal" | "sanction"required

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.convert \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","kind":"sanction"}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "sanction",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Close a case#

POST/v1/relations/cases.closeWrite

Closes an open case with its outcome (no_sanction, sanction, dismissal, dropped, resigned, abandonment) and sets how long it is kept (E9: dismissal and abandonment 1 year and 3 months after the employment ends; a sanction while employed at most 5 years after the decision, 1 year after the employment ends; no sanction 1 year after closing; the company may change these in Settings within the law's range). A case on legal hold is kept until the claim ends. The lead only. A dry run shows the retention date. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_close 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

  • case_idstringrequired

    1–64 characters.

  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • notestring | null

    Up to 2000 characters. Default null.

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.close \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","outcome":"no_sanction"}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "closed",
    "phase": "closed",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": "2026-11-23T10:00:00.000Z",
    "outcome": "no_sanction",
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": "2027-11-23",
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Reopen a closed case#

POST/v1/relations/cases.reopenWrite

Reopens a closed case (closed by mistake, or new facts): its retention date is cleared until it closes again. The lead only. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_cases_reopen 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

  • case_idstringrequired

    1–64 characters.

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/cases.reopen \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1"}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Find the person a new case is about#

POST/v1/relations/people.searchRead

For ER staff opening a case, or a case team asking someone for evidence: people employed today whose name matches q (at most 20), with title and team, never yourself. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_people_search on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • qstring

    Up to 80 characters. Default "".

Returns

  • peopleobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/people.search \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"bea"}'
Response
{
  "data": {
    "people": [
      {
        "id": "p2",
        "name": "Bea Silva",
        "title": "Agent",
        "team": "Support"
      }
    ]
  }
}

Find people to put on a case team#

POST/v1/relations/members.searchRead

For ER staff, a case lead or owners and admins: logins that can work in Manage (owners, admins, HR, custom roles) whose name or email matches q (at most 20), with whether they are ER staff and, given person_id, whether they manage that person (they would see the whole case). In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_members_search on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • qstring

    Up to 80 characters. Default "".

  • person_idstring

    1–64 characters.

Returns

  • membersobject[]required
    5 fields
    • user_idstringrequired
    • namestringrequired
    • emailstringrequired
    • staffbooleanrequired
    • managesbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/members.search \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"marta","person_id":"p2"}'
Response
{
  "data": {
    "members": [
      {
        "user_id": "u2",
        "name": "Marta Dias",
        "email": "marta@acme.example",
        "staff": false,
        "manages": false
      }
    ]
  }
}

Set a case's team#

POST/v1/relations/team.setWrite

Sets who is on the case and in which role (at most 20): exactly one lead (runs it; may hand it over), members (work on the file), a decider (the person with disciplinary power, CT 329(4); may be outside HR) and reviewers (read-only, e.g. in-house counsel). Everyone must be able to work in Manage; the person the case is about never. Someone who manages the person sees the whole case: confirm_chain after the warning, or send them an evidence request instead. The lead only. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_team_set 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

  • case_idstringrequired

    1–64 characters.

  • teamobject[]required

    1–20 items.

    2 fields
    • user_idstringrequired

      1–64 characters.

    • role"lead" | "member" | "decider" | "reviewer"required
  • confirm_chainboolean

    Default false.

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/team.set \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_id": "c1",
  "team": [
    {
      "user_id": "u1",
      "role": "lead"
    },
    {
      "user_id": "u2",
      "role": "decider"
    }
  ]
}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "lead",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Join a case from the register (break-glass)#

POST/v1/relations/team.joinWrite

For owners and admins: joins a case from the register as a reviewer, to see its content (break-glass). Give the reason. It is recorded on the case's timeline and in Activity, and the case's lead is emailed at once (the case number only). Never your own case. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_team_join 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

  • case_idstringrequired

    1–64 characters.

  • reasonstringrequired

    3–500 characters.

Returns

36 fields
  • idstringrequired
  • numberstringrequired
  • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
  • status"open" | "closed"required
  • phasestring (enum)required

    One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

  • personobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • nextobject | nullrequired
    6 fields
    • labelstringrequired
    • basisstringrequired
    • duestringrequired
    • days_leftintegerrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • lapsebooleanrequired
  • lapsedbooleanrequired
  • holdbooleanrequired
  • teamobject[]required
    4 fields
    • user_idstringrequired
    • namestringrequired
    • role"lead" | "member" | "decider" | "reviewer"required
    • via_break_glassbooleanrequired
  • my_role"lead" | "member" | "decider" | "reviewer"required

    null: a register row (owners and admins, not on the team).

  • opened_onstringrequired
  • closed_atstring | nullrequired
  • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
  • packobjectrequired
    7 fields
    • id"pt" | "es" | "eu"required
    • versionstringrequired
    • namestringrequired
    • legalbooleanrequired
    • notestringrequired
    • current_versionstringrequired
    • newerbooleanrequired
  • countrystring | nullrequired
  • factsobject[]required
    7 fields
    • idstringrequired
    • titlestringrequired
    • datesstring[]required
    • learned_onstring | nullrequired
    • crimebooleanrequired
    • crime_untilstring | nullrequired
    • severity"leve" | "grave" | "muy_grave"required
  • flagsobjectrequired
    9 fields
    • repbooleanrequired
    • unionbooleanrequired
    • candidatebooleanrequired
    • microbooleanrequired
    • councilbooleanrequired
    • parentalbooleanrequired
    • complaint_onstring | nullrequired
    • equality_complaintbooleanrequired
    • whistleblowerbooleanrequired
  • parental_from_timeoffbooleanrequired
  • absent_sincestring | nullrequired
  • clocksobject[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • next3object[]required
    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • checksobjectrequired
    2 fields
    • chargesobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • decisionobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
  • protectedobject[]required
    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • person_factsobject | nullrequired
    10 fields
    • idstringrequired
    • namestringrequired
    • statusstringrequired
    • titlestring | nullrequired
    • teamstring | nullrequired
    • locationstring | nullrequired
    • countrystring | nullrequired
    • contract_typestring | nullrequired
    • startstring | nullrequired
    • last_daystring | nullrequired
  • eventsobject[]required
    11 fields
    • idstringrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • labelstringrequired
    • datestringrequired
    • received_onstring | nullrequired
    • due_onstring | nullrequired
    • refstring | nullrequired
    • notestring | nullrequired
    • item_idsstring[]required
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • atstringrequired
  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • requestsobject[]required
    8 fields
    • idstringrequired
    • toobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • item_idsstring[]required
    • atstringrequired
  • counterobject | nullrequired
    5 fields
    • yearintegerrequired
    • totalintegerrequired
    • longest_runintegerrequired
    • reachesbooleanrequired
    • unconfirmedintegerrequired
  • allowed_eventsstring (enum)[]required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • retention_untilstring | nullrequired
  • meobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • canobjectrequired
    2 fields
    • editbooleanrequired
    • leadbooleanrequired
  • filesobjectrequired
    4 fields
    • countintegerrequired
    • bytesintegerrequired
    • max_filesintegerrequired
    • max_bytesintegerrequired
  • bundleobjectrequired
    2 fields
    • lastobject | nullrequired
      2 fields
      • atstringrequired
      • pagesintegerrequired
    • left_todayintegerrequired
  • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/team.join \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","reason":"Board review"}'
Response
{
  "data": {
    "id": "c1",
    "number": "ER-2026-0001",
    "kind": "dismissal",
    "status": "open",
    "phase": "defence",
    "person": {
      "id": "p2",
      "name": "Bea Silva"
    },
    "next": {
      "label": "Defence period",
      "basis": "CT 355(1)",
      "due": "2026-12-07",
      "days_left": 14,
      "state": "running",
      "lapse": false
    },
    "lapsed": false,
    "hold": false,
    "team": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "role": "lead",
        "via_break_glass": false
      }
    ],
    "my_role": "reviewer",
    "opened_on": "2026-11-05",
    "closed_at": null,
    "outcome": null,
    "pack": {
      "id": "pt",
      "version": "2026-11-22",
      "name": "Portugal: Código do Trabalho",
      "legal": true,
      "note": "Deadlines from the Código do Trabalho.",
      "current_version": "2026-11-22",
      "newer": false
    },
    "country": "PT",
    "facts": [
      {
        "id": "f1",
        "title": "Absent without notice",
        "dates": [
          "2026-11-03"
        ],
        "learned_on": "2026-11-05",
        "crime": false,
        "crime_until": null,
        "severity": null
      }
    ],
    "flags": {
      "rep": false,
      "union": false,
      "candidate": false,
      "micro": false,
      "council": false,
      "parental": false,
      "complaint_on": null,
      "equality_complaint": false,
      "whistleblower": false
    },
    "parental_from_timeoff": false,
    "absent_since": null,
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "next3": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "checks": {
      "charges": [],
      "decision": [
        {
          "id": "defence_open",
          "message": "The defence period isn't over.",
          "basis": "CT 355",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "level": "red",
          "values": {}
        }
      ]
    },
    "protected": [],
    "person_facts": {
      "id": "p2",
      "name": "Bea Silva",
      "status": "active",
      "title": "Agent",
      "team": "Support",
      "location": "Lisboa",
      "country": "PT",
      "contract_type": "open_ended",
      "start": "2024-01-08",
      "last_day": null
    },
    "events": [
      {
        "id": "e1",
        "kind": "charges_delivered",
        "label": "Nota de culpa delivered",
        "date": "2026-11-18",
        "received_on": "2026-11-20",
        "due_on": null,
        "ref": null,
        "note": null,
        "item_ids": [],
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "at": "2026-11-21T10:00:00.000Z"
      }
    ],
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "requests": [],
    "counter": {
      "year": 2026,
      "total": 0,
      "longest_run": 0,
      "reaches": false,
      "unconfirmed": 1
    },
    "allowed_events": [
      "charges_delivered",
      "defence_received",
      "note"
    ],
    "retention_until": null,
    "me": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "can": {
      "edit": true,
      "lead": true
    },
    "files": {
      "count": 0,
      "bytes": 0,
      "max_files": 500,
      "max_bytes": 2000000000
    },
    "bundle": {
      "last": null,
      "left_today": 10
    },
    "today": "2026-11-23"
  }
}

Record a case event#

POST/v1/relations/events.recordWrite

Records what happened in a case, on the day it happened: the written charges (nota de culpa) delivered and the day the person received them, the answer received, an extension of the defence period (due_on), evidence steps requested and done or refused with reasons (ref: the request event), the file sent to the works council, opinions, CITE, hearings, the decision delivered, the sanction applied, contact from an absent person, the registered letter, a claim filed (the case is then on legal hold) or ended, a note. Bizisy recomputes every deadline from the events. A dry run shows the procedure check for that step (warnings with the article, never a block) and the deadlines after it. The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_events_record 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

  • case_idstringrequired

    1–64 characters.

  • kindstring (enum)required

    One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

  • datestringrequired

    The day it happened (sent, held, started).

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

  • received_onstring | null

    The day the person (or the council) received it: delivery events start their clocks from it.

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

  • due_onstring | null

    defence_extended: the new last day.

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

  • refstring | null

    evidence_done / evidence_refused: the evidence_requested event id. cite_opinion: favourable or unfavourable.

    Up to 64 characters. Default null.

  • notestring | null

    The team's note (who, what, reasons for a refusal).

    Up to 4000 characters. Default null.

  • item_idsstring[]

    Items of the case file attached as proof (a signed receipt, the AR card).

    1–64 characters. Up to 25 items.

Returns

  • eventobjectrequired
    3 fields
    • idstring | nullrequired
    • kindstring (enum)required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • datestringrequired
  • checksobject[]required

    The procedure check for this step, before it.

    7 fields
    • idstringrequired
    • messagestringrequired

      English with {n}, {date}, {clock} filled from values.

    • basisstringrequired
    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • level"red" | "warning" | "info"required
    • valuesobjectrequired
  • clocksobject[]required

    The deadlines after it.

    16 fields
    • keystringrequired
    • clockstringrequired
    • type"deadline" | "wait" | "info"required
    • fact_idstring | nullrequired
    • labelstringrequired

      English; the app translates it.

    • basisstringrequired

      The article, untranslated: "CT 329(2)".

    • urlstringrequired
    • confidence"verified" | "medium" | "uncertain"required
    • stopsstringrequired
    • if_missedstringrequired
    • lapsebooleanrequired
    • started_onstring | nullrequired
    • duestring | nullrequired
    • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
    • days_leftinteger | nullrequired
    • notestring | nullrequired
  • caseobject | nullrequired

    The case after it (null on a dry run).

    36 fields
    • idstringrequired
    • numberstringrequired
    • kind"dismissal" | "sanction" | "abandonment" | "inquiry"required
    • status"open" | "closed"required
    • phasestring (enum)required

      One of: facts, inquiry, defence, evidence, opinion, decision, decided, applied, absence, letter_sent, closed.

    • personobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • nextobject | nullrequired
      6 fields
      • labelstringrequired
      • basisstringrequired
      • duestringrequired
      • days_leftintegerrequired
      • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
      • lapsebooleanrequired
    • lapsedbooleanrequired
    • holdbooleanrequired
    • teamobject[]required
      4 fields
      • user_idstringrequired
      • namestringrequired
      • role"lead" | "member" | "decider" | "reviewer"required
      • via_break_glassbooleanrequired
    • my_role"lead" | "member" | "decider" | "reviewer"required

      null: a register row (owners and admins, not on the team).

    • opened_onstringrequired
    • closed_atstring | nullrequired
    • outcome"no_sanction" | "sanction" | "dismissal" | "dropped" | "resigned" | "abandonment"required
    • packobjectrequired
      7 fields
      • id"pt" | "es" | "eu"required
      • versionstringrequired
      • namestringrequired
      • legalbooleanrequired
      • notestringrequired
      • current_versionstringrequired
      • newerbooleanrequired
    • countrystring | nullrequired
    • factsobject[]required
      7 fields
      • idstringrequired
      • titlestringrequired
      • datesstring[]required
      • learned_onstring | nullrequired
      • crimebooleanrequired
      • crime_untilstring | nullrequired
      • severity"leve" | "grave" | "muy_grave"required
    • flagsobjectrequired
      9 fields
      • repbooleanrequired
      • unionbooleanrequired
      • candidatebooleanrequired
      • microbooleanrequired
      • councilbooleanrequired
      • parentalbooleanrequired
      • complaint_onstring | nullrequired
      • equality_complaintbooleanrequired
      • whistleblowerbooleanrequired
    • parental_from_timeoffbooleanrequired
    • absent_sincestring | nullrequired
    • clocksobject[]required
      16 fields
      • keystringrequired
      • clockstringrequired
      • type"deadline" | "wait" | "info"required
      • fact_idstring | nullrequired
      • labelstringrequired

        English; the app translates it.

      • basisstringrequired

        The article, untranslated: "CT 329(2)".

      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • stopsstringrequired
      • if_missedstringrequired
      • lapsebooleanrequired
      • started_onstring | nullrequired
      • duestring | nullrequired
      • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
      • days_leftinteger | nullrequired
      • notestring | nullrequired
    • next3object[]required
      16 fields
      • keystringrequired
      • clockstringrequired
      • type"deadline" | "wait" | "info"required
      • fact_idstring | nullrequired
      • labelstringrequired

        English; the app translates it.

      • basisstringrequired

        The article, untranslated: "CT 329(2)".

      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • stopsstringrequired
      • if_missedstringrequired
      • lapsebooleanrequired
      • started_onstring | nullrequired
      • duestring | nullrequired
      • state"waiting" | "running" | "ended" | "met" | "missed" | "info"required
      • days_leftinteger | nullrequired
      • notestring | nullrequired
    • checksobjectrequired
      2 fields
      • chargesobject[]required
        7 fields
        • idstringrequired
        • messagestringrequired

          English with {n}, {date}, {clock} filled from values.

        • basisstringrequired
        • urlstringrequired
        • confidence"verified" | "medium" | "uncertain"required
        • level"red" | "warning" | "info"required
        • valuesobjectrequired
      • decisionobject[]required
        7 fields
        • idstringrequired
        • messagestringrequired

          English with {n}, {date}, {clock} filled from values.

        • basisstringrequired
        • urlstringrequired
        • confidence"verified" | "medium" | "uncertain"required
        • level"red" | "warning" | "info"required
        • valuesobjectrequired
    • protectedobject[]required
      7 fields
      • idstringrequired
      • messagestringrequired

        English with {n}, {date}, {clock} filled from values.

      • basisstringrequired
      • urlstringrequired
      • confidence"verified" | "medium" | "uncertain"required
      • level"red" | "warning" | "info"required
      • valuesobjectrequired
    • person_factsobject | nullrequired
      10 fields
      • idstringrequired
      • namestringrequired
      • statusstringrequired
      • titlestring | nullrequired
      • teamstring | nullrequired
      • locationstring | nullrequired
      • countrystring | nullrequired
      • contract_typestring | nullrequired
      • startstring | nullrequired
      • last_daystring | nullrequired
    • eventsobject[]required
      11 fields
      • idstringrequired
      • kindstring (enum)required

        One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

      • labelstringrequired
      • datestringrequired
      • received_onstring | nullrequired
      • due_onstring | nullrequired
      • refstring | nullrequired
      • notestring | nullrequired
      • item_idsstring[]required
      • byobjectrequired
        2 fields
        • user_idstringrequired
        • namestringrequired
      • atstringrequired
    • itemsobject[]required
      16 fields
      • idstringrequired
      • doc_nostringrequired
      • kind"record" | "file" | "statement"required
      • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
      • labelstringrequired
      • onstring | nullrequired
      • sourceobject | nullrequired
        4 fields
        • modulestringrequired
        • typestring (enum)required

          One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

        • refstringrequired
        • hashstringrequired
      • snapshotobject | nullrequired
      • fileobject | nullrequired
        6 fields
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • sha256string | nullrequired
        • pagesinteger | nullrequired
        • status"pending" | "ready"required
      • emailobject | nullrequired
        8 fields
        • fromstring | nullrequired
        • tostring | nullrequired
        • ccstring | nullrequired
        • datestring | nullrequired
        • subjectstring | nullrequired
        • textstringrequired
        • truncatedbooleanrequired
        • attachmentsobject[]required
          5 fields
          • indexintegerrequired
          • namestringrequired
          • content_typestringrequired
          • sizeintegerrequired
          • extracted_item_idstring | nullrequired
      • statementstring | nullrequired
      • confirmed"unjustified" | "justified"required
      • from_requestobject | nullrequired
        2 fields
        • request_idstringrequired
        • personobjectrequired
          2 fields
          • idstringrequired
          • namestringrequired
      • linked_byobjectrequired
        2 fields
        • user_idstringrequired
        • namestringrequired
      • linked_atstringrequired
      • removedobject | nullrequired
        3 fields
        • atstringrequired
        • bystringrequired
        • reasonstring | nullrequired
    • requestsobject[]required
      8 fields
      • idstringrequired
      • toobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • askstringrequired
      • duestring | nullrequired
      • status"open" | "answered" | "cancelled" | "expired"required
      • answered_atstring | nullrequired
      • item_idsstring[]required
      • atstringrequired
    • counterobject | nullrequired
      5 fields
      • yearintegerrequired
      • totalintegerrequired
      • longest_runintegerrequired
      • reachesbooleanrequired
      • unconfirmedintegerrequired
    • allowed_eventsstring (enum)[]required

      One of: inquiry_started, inquiry_ended, suspension_started, suspension_ended, charges_delivered, defence_extended, defence_received, union_named, evidence_requested, evidence_done, evidence_refused, hearing_offered, hearing_held, expediente_opened, file_to_council, opinion_received, cite_sent, cite_opinion, decision_delivered, sanction_applied, contact_recorded, registered_letter_sent, claim_filed, claim_ended, note, item_removed, converted, closed, reopened.

    • retention_untilstring | nullrequired
    • meobjectrequired
      3 fields
      • lettersbooleanrequired
      • answerbooleanrequired
      • consultbooleanrequired
    • canobjectrequired
      2 fields
      • editbooleanrequired
      • leadbooleanrequired
    • filesobjectrequired
      4 fields
      • countintegerrequired
      • bytesintegerrequired
      • max_filesintegerrequired
      • max_bytesintegerrequired
    • bundleobjectrequired
      2 fields
      • lastobject | nullrequired
        2 fields
        • atstringrequired
        • pagesintegerrequired
      • left_todayintegerrequired
    • todaystringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/events.record \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_id": "c1",
  "kind": "charges_delivered",
  "date": "2026-11-18",
  "received_on": "2026-11-20"
}'
Response
{
  "data": {
    "event": {
      "id": "e1",
      "kind": "charges_delivered",
      "date": "2026-11-18"
    },
    "checks": [],
    "clocks": [
      {
        "key": "C6",
        "clock": "C6",
        "type": "wait",
        "fact_id": null,
        "label": "Defence period",
        "basis": "CT 355(1)",
        "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
        "confidence": "verified",
        "stops": "The answer received early, or an extension the team grants (recorded)",
        "if_missed": "The team may go on with the procedure.",
        "lapse": false,
        "started_on": "2026-11-20",
        "due": "2026-12-07",
        "state": "running",
        "days_left": 14,
        "note": null
      }
    ],
    "case": {
      "id": "c1",
      "number": "ER-2026-0001",
      "kind": "dismissal",
      "status": "open",
      "phase": "defence",
      "person": {
        "id": "p2",
        "name": "Bea Silva"
      },
      "next": {
        "label": "Defence period",
        "basis": "CT 355(1)",
        "due": "2026-12-07",
        "days_left": 14,
        "state": "running",
        "lapse": false
      },
      "lapsed": false,
      "hold": false,
      "team": [
        {
          "user_id": "u1",
          "name": "Rui Lopes",
          "role": "lead",
          "via_break_glass": false
        }
      ],
      "my_role": "lead",
      "opened_on": "2026-11-05",
      "closed_at": null,
      "outcome": null,
      "pack": {
        "id": "pt",
        "version": "2026-11-22",
        "name": "Portugal: Código do Trabalho",
        "legal": true,
        "note": "Deadlines from the Código do Trabalho.",
        "current_version": "2026-11-22",
        "newer": false
      },
      "country": "PT",
      "facts": [
        {
          "id": "f1",
          "title": "Absent without notice",
          "dates": [
            "2026-11-03"
          ],
          "learned_on": "2026-11-05",
          "crime": false,
          "crime_until": null,
          "severity": null
        }
      ],
      "flags": {
        "rep": false,
        "union": false,
        "candidate": false,
        "micro": false,
        "council": false,
        "parental": false,
        "complaint_on": null,
        "equality_complaint": false,
        "whistleblower": false
      },
      "parental_from_timeoff": false,
      "absent_since": null,
      "clocks": [
        {
          "key": "C6",
          "clock": "C6",
          "type": "wait",
          "fact_id": null,
          "label": "Defence period",
          "basis": "CT 355(1)",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "stops": "The answer received early, or an extension the team grants (recorded)",
          "if_missed": "The team may go on with the procedure.",
          "lapse": false,
          "started_on": "2026-11-20",
          "due": "2026-12-07",
          "state": "running",
          "days_left": 14,
          "note": null
        }
      ],
      "next3": [
        {
          "key": "C6",
          "clock": "C6",
          "type": "wait",
          "fact_id": null,
          "label": "Defence period",
          "basis": "CT 355(1)",
          "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
          "confidence": "verified",
          "stops": "The answer received early, or an extension the team grants (recorded)",
          "if_missed": "The team may go on with the procedure.",
          "lapse": false,
          "started_on": "2026-11-20",
          "due": "2026-12-07",
          "state": "running",
          "days_left": 14,
          "note": null
        }
      ],
      "checks": {
        "charges": [],
        "decision": [
          {
            "id": "defence_open",
            "message": "The defence period isn't over.",
            "basis": "CT 355",
            "url": "https://www.pgdlisboa.pt/leis/lei_mostra_articulado.php?artigo_id=1047A0355&nid=1047&tabela=leis",
            "confidence": "verified",
            "level": "red",
            "values": {}
          }
        ]
      },
      "protected": [],
      "person_facts": {
        "id": "p2",
        "name": "Bea Silva",
        "status": "active",
        "title": "Agent",
        "team": "Support",
        "location": "Lisboa",
        "country": "PT",
        "contract_type": "open_ended",
        "start": "2024-01-08",
        "last_day": null
      },
      "events": [
        {
          "id": "e1",
          "kind": "charges_delivered",
          "label": "Nota de culpa delivered",
          "date": "2026-11-18",
          "received_on": "2026-11-20",
          "due_on": null,
          "ref": null,
          "note": null,
          "item_ids": [],
          "by": {
            "user_id": "u1",
            "name": "Rui Lopes"
          },
          "at": "2026-11-21T10:00:00.000Z"
        }
      ],
      "items": [
        {
          "id": "i1",
          "doc_no": "D-1",
          "kind": "record",
          "role": "evidence",
          "label": "No record, 2026-11-03, scheduled 09:00–18:00",
          "on": "2026-11-03",
          "source": {
            "module": "timeclock",
            "type": "timeclock_no_record",
            "ref": "no_record:2026-11-03",
            "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "snapshot": {
            "date": "2026-11-03",
            "start": "09:00",
            "end": "18:00"
          },
          "file": null,
          "email": null,
          "statement": null,
          "confirmed": null,
          "from_request": null,
          "linked_by": {
            "user_id": "u1",
            "name": "Rui Lopes"
          },
          "linked_at": "2026-11-21T10:00:00.000Z",
          "removed": null
        }
      ],
      "requests": [],
      "counter": {
        "year": 2026,
        "total": 0,
        "longest_run": 0,
        "reaches": false,
        "unconfirmed": 1
      },
      "allowed_events": [
        "charges_delivered",
        "defence_received",
        "note"
      ],
      "retention_until": null,
      "me": {
        "letters": true,
        "answer": true,
        "consult": true
      },
      "can": {
        "edit": true,
        "lead": true
      },
      "files": {
        "count": 0,
        "bytes": 0,
        "max_files": 500,
        "max_bytes": 2000000000
      },
      "bundle": {
        "last": null,
        "left_today": 10
      },
      "today": "2026-11-23"
    }
  }
}

Records to pick as evidence#

POST/v1/relations/evidence.sourcesRead

What one source holds about the case's person between from and to (default the last 60 days; the time clock and shifts read at most 93 days, time off a year): time clock days with no record or late, time off, rostered shifts, mandatory training overdue or failed, their documents, job and contract facts, or earlier closed cases (number, kind, outcome only). Each with the facts as they are now and whether it is already in the file. The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_evidence_sources on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

  • sourcestring (enum)required

    One of: timeclock, timeoff, shifts, training, documents, org, cases.

  • fromstring

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

  • tostring

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

Returns

  • sourcestring (enum)required

    One of: timeclock, timeoff, shifts, training, documents, org, cases.

  • availablebooleanrequired

    false: that module is switched off or not on this server.

  • fromstringrequired
  • tostringrequired
  • max_daysinteger | nullrequired
  • candidatesobject[]required
    7 fields
    • typestring (enum)required

      One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

    • refstringrequired
    • labelstringrequired
    • onstring | nullrequired
    • snapshotobjectrequired
    • hashstringrequired
    • linked_item_idstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/evidence.sources \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "case_id": "c1",
  "source": "timeoff",
  "from": "2026-01-01",
  "to": "2026-11-23"
}'
Response
{
  "data": {
    "source": "timeoff",
    "available": true,
    "from": "2026-01-01",
    "to": "2026-11-23",
    "max_days": 93,
    "candidates": [
      {
        "type": "timeclock_no_record",
        "ref": "no_record:2026-11-03",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "snapshot": {
          "date": "2026-11-03"
        },
        "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "linked_item_id": null
      }
    ]
  }
}

POST/v1/relations/items.linkWrite

Adds picked records (source and ref from relations_evidence_sources, at most 50 at a time) to the case file. Bizisy reads each again from its module and keeps a snapshot with provenance (module, record, who, when, a hash); a document from Documents is copied into the case. Time clock days with no record start Unconfirmed: mark them with relations_items_confirm. The lead and members. A dry run shows what would be added. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_link 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

  • case_idstringrequired

    1–64 characters.

  • fromstring

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

  • tostring

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

  • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"

    Default "evidence".

  • picksobject[]required

    1–50 items.

    2 fields
    • sourcestring (enum)required

      One of: timeclock, timeoff, shifts, training, documents, org, cases.

    • refstringrequired

      1–200 characters.

Returns

  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired
  • skippedstring[]required

    Refs no longer found or already in the file.

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

Response
{
  "data": {
    "items": [
      {
        "id": "i1",
        "doc_no": "D-1",
        "kind": "record",
        "role": "evidence",
        "label": "No record, 2026-11-03, scheduled 09:00–18:00",
        "on": "2026-11-03",
        "source": {
          "module": "timeclock",
          "type": "timeclock_no_record",
          "ref": "no_record:2026-11-03",
          "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "snapshot": {
          "date": "2026-11-03",
          "start": "09:00",
          "end": "18:00"
        },
        "file": null,
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ],
    "skipped": []
  }
}

Check whether linked records changed#

POST/v1/relations/items.check_sourcesRead

For the case file's linked records, whether the source changed since it was linked (a late justification turned an absence into sick leave, for example): each changed item with the facts now (null: gone). Both versions stay; nothing is changed. The team. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_check_sources on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

Returns

  • changedobject[]required
    2 fields
    • item_idstringrequired
    • nowobject | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.check_sources \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1"}'
Response
{
  "data": {
    "changed": []
  }
}

Start uploading files to a case file#

POST/v1/relations/items.upload_urlWrite

Starts uploads to the case file (at most 25 files at a time, 5 unfinished per person at once): PDF, Word (DOCX), ODT, text, images (PNG, JPEG, WebP, HEIC) or emails saved as .eml, up to 50 MB and 300 pages each; 500 files and 2 GB a case, counted in the company's storage. Returns signed upload URLs (bound to each file's size and type); then upload the bytes and call relations_items_finish. Outlook .msg files are refused: save the email as PDF or .eml. The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_upload_url 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

  • case_idstringrequired

    1–64 characters.

  • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"

    Default "evidence".

  • filesobject[]required

    1–25 items.

    4 fields
    • namestringrequired

      1–255 characters.

    • sizeintegerrequired

      From 1 to 50000000.

    • content_typestringrequired

      1–120 characters.

    • sha256stringrequired

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

Returns

  • uploadsobject[]required
    4 fields
    • item_idstringrequired
    • namestringrequired
    • uploadobject | nullrequired
      3 fields
      • urlstringrequired
      • methodstringrequired
      • headersobjectrequired
    • expires_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.upload_url \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_id": "c1",
  "files": [
    {
      "name": "defence.pdf",
      "size": 1000,
      "content_type": "application/pdf",
      "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}'
Response
{
  "data": {
    "uploads": [
      {
        "item_id": "i2",
        "name": "defence.pdf",
        "upload": {
          "url": "https://storage.example/upload",
          "method": "PUT",
          "headers": {
            "content-type": "application/pdf"
          }
        },
        "expires_at": "2026-11-23T10:15:00.000Z"
      }
    ]
  }
}

Finish uploads to a case file#

POST/v1/relations/items.finishWrite

Checks each uploaded file by its content (type, size, SHA-256; PDFs at most 300 pages), gives it its case document number (D-n) and, for an .eml, reads its headers, text and attachments (never its remote content). The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_finish 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

  • case_idstringrequired

    1–64 characters.

  • item_idsstring[]required

    1–64 characters. 1–25 items.

Returns

  • itemsobject[]required
    16 fields
    • idstringrequired
    • doc_nostringrequired
    • kind"record" | "file" | "statement"required
    • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
    • labelstringrequired
    • onstring | nullrequired
    • sourceobject | nullrequired
      4 fields
      • modulestringrequired
      • typestring (enum)required

        One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

      • refstringrequired
      • hashstringrequired
    • snapshotobject | nullrequired
    • fileobject | nullrequired
      6 fields
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • sha256string | nullrequired
      • pagesinteger | nullrequired
      • status"pending" | "ready"required
    • emailobject | nullrequired
      8 fields
      • fromstring | nullrequired
      • tostring | nullrequired
      • ccstring | nullrequired
      • datestring | nullrequired
      • subjectstring | nullrequired
      • textstringrequired
      • truncatedbooleanrequired
      • attachmentsobject[]required
        5 fields
        • indexintegerrequired
        • namestringrequired
        • content_typestringrequired
        • sizeintegerrequired
        • extracted_item_idstring | nullrequired
    • statementstring | nullrequired
    • confirmed"unjustified" | "justified"required
    • from_requestobject | nullrequired
      2 fields
      • request_idstringrequired
      • personobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired
    • linked_byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • linked_atstringrequired
    • removedobject | nullrequired
      3 fields
      • atstringrequired
      • bystringrequired
      • reasonstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.finish \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","item_ids":["i2"]}'
Response
{
  "data": {
    "items": [
      {
        "id": "i2",
        "doc_no": "D-2",
        "kind": "file",
        "role": "evidence",
        "label": "defence.pdf",
        "on": "2026-11-03",
        "source": null,
        "snapshot": null,
        "file": {
          "name": "defence.pdf",
          "content_type": "application/pdf",
          "size": 1000,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "pages": 3,
          "status": "ready"
        },
        "email": null,
        "statement": null,
        "confirmed": null,
        "from_request": null,
        "linked_by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "linked_at": "2026-11-21T10:00:00.000Z",
        "removed": null
      }
    ]
  }
}

Mark days with no record as unjustified or justified#

POST/v1/relations/items.confirmWrite

Marks time clock days with no record in the case file as unjustified or justified (null: back to Unconfirmed). Bizisy can't know whether an absence was justified (CT 253–254 allow a late justification): only confirmed days count toward CT 351(2)(g). The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_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

  • case_idstringrequired

    1–64 characters.

  • item_idsstring[]required

    1–64 characters. 1–200 items.

  • confirmed"unjustified" | "justified"required

Returns

  • updatedintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.confirm \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","item_ids":["i1"],"confirmed":"unjustified"}'
Response
{
  "data": {
    "updated": 1
  }
}

Remove an item from a case file#

POST/v1/relations/items.removeWrite

Removes an item from the case file: its file is deleted, and the removal stays on the timeline with who, when and why (never silent); its D-number is not reused. The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_remove 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

  • case_idstringrequired

    1–64 characters.

  • item_idstringrequired

    1–64 characters.

  • reasonstring | null

    Up to 500 characters. Default null.

Returns

16 fields
  • idstringrequired
  • doc_nostringrequired
  • kind"record" | "file" | "statement"required
  • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
  • labelstringrequired
  • onstring | nullrequired
  • sourceobject | nullrequired
    4 fields
    • modulestringrequired
    • typestring (enum)required

      One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

    • refstringrequired
    • hashstringrequired
  • snapshotobject | nullrequired
  • fileobject | nullrequired
    6 fields
    • namestringrequired
    • content_typestringrequired
    • sizeintegerrequired
    • sha256string | nullrequired
    • pagesinteger | nullrequired
    • status"pending" | "ready"required
  • emailobject | nullrequired
    8 fields
    • fromstring | nullrequired
    • tostring | nullrequired
    • ccstring | nullrequired
    • datestring | nullrequired
    • subjectstring | nullrequired
    • textstringrequired
    • truncatedbooleanrequired
    • attachmentsobject[]required
      5 fields
      • indexintegerrequired
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • extracted_item_idstring | nullrequired
  • statementstring | nullrequired
  • confirmed"unjustified" | "justified"required
  • from_requestobject | nullrequired
    2 fields
    • request_idstringrequired
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • linked_byobjectrequired
    2 fields
    • user_idstringrequired
    • namestringrequired
  • linked_atstringrequired
  • removedobject | nullrequired
    3 fields
    • atstringrequired
    • bystringrequired
    • reasonstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.remove \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","item_id":"i1","reason":"Justified late"}'
Response
{
  "data": {
    "id": "i1",
    "doc_no": "D-1",
    "kind": "record",
    "role": "evidence",
    "label": "No record, 2026-11-03, scheduled 09:00–18:00",
    "on": "2026-11-03",
    "source": {
      "module": "timeclock",
      "type": "timeclock_no_record",
      "ref": "no_record:2026-11-03",
      "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "snapshot": {
      "date": "2026-11-03",
      "start": "09:00",
      "end": "18:00"
    },
    "file": null,
    "email": null,
    "statement": null,
    "confirmed": null,
    "from_request": null,
    "linked_by": {
      "user_id": "u1",
      "name": "Rui Lopes"
    },
    "linked_at": "2026-11-21T10:00:00.000Z",
    "removed": {
      "at": "2026-11-23T10:00:00.000Z",
      "by": "Rui Lopes",
      "reason": "Justified late"
    }
  }
}

Add an email attachment as its own item#

POST/v1/relations/items.extractWrite

Adds one attachment of an .eml in the case file as an item of its own (checked by content like an upload; types storage refuses stay listed only). The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_extract 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

  • case_idstringrequired

    1–64 characters.

  • item_idstringrequired

    1–64 characters.

  • indexintegerrequired

    From 0 to 1000.

Returns

16 fields
  • idstringrequired
  • doc_nostringrequired
  • kind"record" | "file" | "statement"required
  • role"evidence" | "defence" | "statement" | "proof" | "opinion" | "other"required
  • labelstringrequired
  • onstring | nullrequired
  • sourceobject | nullrequired
    4 fields
    • modulestringrequired
    • typestring (enum)required

      One of: timeclock_no_record, timeclock_late, timeoff, shifts, training_assigned, training_failed, documents, org_facts, earlier_case.

    • refstringrequired
    • hashstringrequired
  • snapshotobject | nullrequired
  • fileobject | nullrequired
    6 fields
    • namestringrequired
    • content_typestringrequired
    • sizeintegerrequired
    • sha256string | nullrequired
    • pagesinteger | nullrequired
    • status"pending" | "ready"required
  • emailobject | nullrequired
    8 fields
    • fromstring | nullrequired
    • tostring | nullrequired
    • ccstring | nullrequired
    • datestring | nullrequired
    • subjectstring | nullrequired
    • textstringrequired
    • truncatedbooleanrequired
    • attachmentsobject[]required
      5 fields
      • indexintegerrequired
      • namestringrequired
      • content_typestringrequired
      • sizeintegerrequired
      • extracted_item_idstring | nullrequired
  • statementstring | nullrequired
  • confirmed"unjustified" | "justified"required
  • from_requestobject | nullrequired
    2 fields
    • request_idstringrequired
    • personobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • linked_byobjectrequired
    2 fields
    • user_idstringrequired
    • namestringrequired
  • linked_atstringrequired
  • removedobject | nullrequired
    3 fields
    • atstringrequired
    • bystringrequired
    • reasonstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/items.extract \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","item_id":"i3","index":1}'
Response
{
  "data": {
    "id": "i4",
    "doc_no": "D-4",
    "kind": "file",
    "role": "evidence",
    "label": "No record, 2026-11-03, scheduled 09:00–18:00",
    "on": "2026-11-03",
    "source": null,
    "snapshot": null,
    "file": null,
    "email": null,
    "statement": null,
    "confirmed": null,
    "from_request": null,
    "linked_by": {
      "user_id": "u1",
      "name": "Rui Lopes"
    },
    "linked_at": "2026-11-21T10:00:00.000Z",
    "removed": null
  }
}

Download a file from a case file#

POST/v1/relations/items.downloadRead

A short-lived download link for one file in the case file (5 minutes). The team. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_items_download on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

  • item_idstringrequired

    1–64 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/relations/items.download \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1","item_id":"i2"}'
Response
{
  "data": {
    "url": "https://storage.example/file",
    "expires_at": "2026-11-23T10:05:00.000Z",
    "name": "D-2 defence.pdf"
  }
}

Ask someone for evidence#

POST/v1/relations/requests.sendWrite

Asks a person who is not on the case team (a manager, a witness) for documents or a written statement, in your words. They get a task in My workspace and an email that names only the case number; they never see the case. Not the person the case is about. Up to 20 open requests a case and 50 a lead a day. The lead only. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_requests_send 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

  • case_idstringrequired

    1–64 characters.

  • to_person_idstringrequired

    1–64 characters.

  • askstringrequired

    5–2000 characters.

  • duestring | null

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

Returns

  • idstringrequired
  • toobjectrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • askstringrequired
  • duestring | nullrequired
  • status"open" | "answered" | "cancelled" | "expired"required
  • atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/requests.send \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_id": "c1",
  "to_person_id": "p5",
  "ask": "Upload the training invitations you sent in October."
}'
Response
{
  "data": {
    "id": "r1",
    "to": {
      "id": "p5",
      "name": "Joao Pires"
    },
    "ask": "Upload the training invitations you sent in October.",
    "due": null,
    "status": "open",
    "at": "2026-11-23T10:00:00.000Z"
  }
}

Cancel an evidence request#

POST/v1/relations/requests.cancelWrite

Cancels an open evidence request: the recipient sees it is no longer needed. The lead only. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_requests_cancel 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

  • case_idstringrequired

    1–64 characters.

  • request_idstringrequired

    1–64 characters.

Returns

  • idstringrequired
  • status"cancelled"required

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/requests.cancel \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","request_id":"r1"}'
Response
{
  "data": {
    "id": "r1",
    "status": "cancelled"
  }
}

Requests from HR#

POST/v1/relations/me.requestsRead

The evidence requests HR sent you (open, and those answered or closed in the last 90 days): the case number, what is asked, by when, and what you sent. Never the case itself. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_me_requests on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • itemsobject[]required
    8 fields
    • idstringrequired
    • numberstringrequired

      The case number: the only thing about the case the recipient sees.

    • askstringrequired
    • duestring | nullrequired
    • status"open" | "answered" | "cancelled" | "expired"required
    • answered_atstring | nullrequired
    • sentintegerrequired
    • atstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/me.requests \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "items": [
      {
        "id": "r1",
        "number": "ER-2026-0001",
        "ask": "Upload the training invitations you sent in October.",
        "due": "2026-11-30",
        "status": "open",
        "answered_at": null,
        "sent": 0,
        "at": "2026-11-23T10:00:00.000Z"
      }
    ]
  }
}

Start uploading files for HR#

POST/v1/relations/me.requests.upload_urlWrite

Starts uploads for an open request from HR (at most 25 files, 5 at once; PDF, Word, ODT, text, images or .eml emails, up to 50 MB each). Then upload the bytes and send them with relations_me_requests_answer. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_me_requests_upload_url on My Workplace
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity

Input

  • request_idstringrequired

    1–64 characters.

  • filesobject[]required

    1–25 items.

    4 fields
    • namestringrequired

      1–255 characters.

    • sizeintegerrequired

      From 1 to 50000000.

    • content_typestringrequired

      1–120 characters.

    • sha256stringrequired

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

Returns

  • uploadsobject[]required
    4 fields
    • upload_idstringrequired
    • namestringrequired
    • uploadobject | nullrequired
      3 fields
      • urlstringrequired
      • methodstringrequired
      • headersobjectrequired
    • expires_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/me.requests.upload_url \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "request_id": "r1",
  "files": [
    {
      "name": "invite.eml",
      "size": 900,
      "content_type": "message/rfc822",
      "sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
    }
  ]
}'
Response
{
  "data": {
    "uploads": [
      {
        "upload_id": "i9",
        "name": "invite.eml",
        "upload": null,
        "expires_at": "2026-11-23T10:15:00.000Z"
      }
    ]
  }
}

Send HR what they asked for#

POST/v1/relations/me.requests.answerWrite

Sends your answer to a request from HR: the files you uploaded (upload_ids) and/or a written statement. HR receives them with the time; you get a receipt. Once sent, an answer can't be changed here (ask HR). In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_me_requests_answer on My Workplace
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity

Input

  • request_idstringrequired

    1–64 characters.

  • upload_idsstring[]

    1–64 characters. Up to 25 items.

  • statementstring | null

    Up to 20000 characters. Default null.

Returns

  • idstringrequired
  • numberstringrequired
  • answered_atstringrequired
  • sentintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/me.requests.answer \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"request_id":"r1","statement":"I sent them on 2 and 9 October."}'
Response
{
  "data": {
    "id": "r1",
    "number": "ER-2026-0001",
    "answered_at": "2026-11-23T10:00:00.000Z",
    "sent": 1
  }
}

Download the case file as one PDF#

POST/v1/relations/bundle.exportWrite

Builds the case file as one PDF: a numbered index (D-numbers, dates, pages), the timeline, then every item in order (PDFs page by page, images, records, statements and emails as text, other files named with their SHA-256), each page stamped with the case number, its document and the page. Up to 2000 pages, 10 a case a day; it counts in the company's storage. Returns a 5-minute download link. The team. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_bundle_export 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

  • case_idstringrequired

    1–64 characters.

  • language"en" | "pt" | "es" | "fr" | "de" | "it"

    Default "en".

  • include_removedfalse

    Default false.

Returns

  • urlstring | nullrequired
  • expires_atstring | nullrequired
  • pagesintegerrequired
  • itemsintegerrequired
  • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/bundle.export \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","language":"pt"}'
Response
{
  "data": {
    "url": "https://storage.example/bundle",
    "expires_at": "2026-11-23T10:05:00.000Z",
    "pages": 12,
    "items": 4,
    "name": "ER-2026-0001 Case file.pdf"
  }
}

Employee relations settings#

POST/v1/relations/settings.getRead

Who can run cases, the rule packs on (Portugal, Spain; other countries use the fair-process fallback), the Spanish convenio faults with their severity, whether the Portuguese CBA doubles the sanction limits, the reminder days, the retention periods with the law's range, the fallback's own periods and what people see in My workspace. Owners and admins; ER staff read them. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_settings_get on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

13 fields
  • staffobject[]required
    3 fields
    • user_idstringrequired
    • namestringrequired
    • emailstringrequired
  • packsobjectrequired
    2 fields
    • ptbooleanrequired
    • esbooleanrequired
  • convenioobject[]required
    3 fields
    • idstringrequired
    • labelstringrequired
    • severity"leve" | "grave" | "muy_grave"required
  • cba_doublebooleanrequired
  • reminder_offsetsinteger[]required
  • remind_membersbooleanrequired
  • retentionobjectrequired
    4 fields
    • dismissal_monthsintegerrequired
    • sanction_monthsintegerrequired
    • sanction_yearsintegerrequired
    • no_sanction_monthsintegerrequired
  • retention_rangesobjectrequired
  • eu_defaultsobjectrequired
    2 fields
    • defence_daysintegerrequired
    • decision_daysintegerrequired
  • me_defaultobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • wizardobjectrequired
    4 fields
    • staffbooleanrequired
    • rulesbooleanrequired
    • retentionbooleanrequired
    • aibooleanrequired
  • aiobjectrequired
    5 fields
    • availablebooleanrequired

      This server can run the case assistant (a model and file storage).

    • onbooleanrequired
    • overseeobject[]required

      The people who oversee it (AI Act Art. 26(2)).

      2 fields
      • user_idstringrequired
      • namestringrequired
    • informed_onstring | nullrequired

      The day the company told its workers' representatives and workers that it is used (Art. 26(7)).

    • addendumobjectrequired
      3 fields
      • acceptedbooleanrequired
      • versionstringrequired
      • accepted_versionstring | nullrequired
  • can_editbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/settings.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "staff": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "email": "rui@acme.example"
      }
    ],
    "packs": {
      "pt": true,
      "es": true
    },
    "convenio": [],
    "cba_double": false,
    "reminder_offsets": [
      7,
      3,
      1,
      0
    ],
    "remind_members": false,
    "retention": {
      "dismissal_months": 15,
      "sanction_months": 12,
      "sanction_years": 5,
      "no_sanction_months": 12
    },
    "retention_ranges": {
      "dismissal_months": [
        15,
        60
      ]
    },
    "eu_defaults": {
      "defence_days": 10,
      "decision_days": 30
    },
    "me_default": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "wizard": {
      "staff": true,
      "rules": false,
      "retention": false,
      "ai": false
    },
    "ai": {
      "available": true,
      "on": true,
      "oversee": [
        {
          "user_id": "u1",
          "name": "Rui Lopes"
        }
      ],
      "informed_on": "2026-11-20",
      "addendum": {
        "accepted": true,
        "version": "ai-6",
        "accepted_version": "ai-6"
      }
    },
    "can_edit": true
  }
}

Change Employee relations settings#

POST/v1/relations/settings.updateWrite

Changes Employee relations settings (only the fields given): staff (user ids who can open cases and be on teams; at most 200; owners, admins, HR or custom-role logins), packs ({pt, es}), convenio (the Spanish convenio faults: label and severity leve, grave or muy_grave), cba_double, reminder_offsets (days before a deadline, 0 = on the day; up to 6, 0–30), remind_members, retention (months and years within the law's range: dismissal 15–60 months after the employment ends; sanction 12–60 months after it ends and 1–10 years while employed; no sanction 12–60 months after closing), eu_defaults (the fallback's days to answer 1–60 and to decide 1–120), me_default, wizard (the setup steps done), ai (the case assistant: on, oversee — who oversees it, informed_on — the day the workers' representatives and workers were told; switching on needs the AI features addendum for case_assistant accepted by an owner, here with accept_addendum or before, the day they were told and someone overseeing it; off by default; off stops readings in progress and keeps the drafts). Owners and admins (accepting the addendum: owners). Supports dry_run. In the app only.

Web app only
Refused for API keys and connected apps. Employee relations works only in the Bizisy app: a case is confidential to its team.
MCP tool
relations_settings_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

  • staffstring[]

    Up to 200 items.

  • packsobject
    2 fields
    • ptboolean
    • esboolean
  • convenioobject[]

    Up to 200 items.

    3 fields
    • idstring

      Up to 20 characters.

    • labelstringrequired

      1–160 characters.

    • severity"leve" | "grave" | "muy_grave"required
  • cba_doubleboolean
  • reminder_offsetsinteger[]

    From 0 to 30. Up to 6 items.

  • remind_membersboolean
  • retentionobject
    4 fields
    • dismissal_monthsinteger

      From 15 to 60.

    • sanction_monthsinteger

      From 12 to 60.

    • sanction_yearsinteger

      From 1 to 10.

    • no_sanction_monthsinteger

      From 12 to 60.

  • eu_defaultsobject
    2 fields
    • defence_daysinteger

      From 1 to 60.

    • decision_daysinteger

      From 1 to 120.

  • me_defaultobject
    3 fields
    • lettersboolean
    • answerboolean
    • consultboolean
  • wizardobject
    4 fields
    • staffboolean
    • rulesboolean
    • retentionboolean
    • aiboolean
  • aiobject
    3 fields
    • onboolean
    • overseestring[]

      User ids of the people who oversee the case assistant (default: who can run cases).

      Up to 200 items.

    • informed_onstring | null

      The day the workers' representatives and workers were told it is used.

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

  • accept_addendumobject

    Owners only: accept the AI features addendum for the case assistant (the version shown in Settings → Employee relations → AI reading).

    2 fields
    • versionstringrequired
    • lang"en" | "de" | "es" | "fr" | "it" | "pt"

      Default "en".

Returns

13 fields
  • staffobject[]required
    3 fields
    • user_idstringrequired
    • namestringrequired
    • emailstringrequired
  • packsobjectrequired
    2 fields
    • ptbooleanrequired
    • esbooleanrequired
  • convenioobject[]required
    3 fields
    • idstringrequired
    • labelstringrequired
    • severity"leve" | "grave" | "muy_grave"required
  • cba_doublebooleanrequired
  • reminder_offsetsinteger[]required
  • remind_membersbooleanrequired
  • retentionobjectrequired
    4 fields
    • dismissal_monthsintegerrequired
    • sanction_monthsintegerrequired
    • sanction_yearsintegerrequired
    • no_sanction_monthsintegerrequired
  • retention_rangesobjectrequired
  • eu_defaultsobjectrequired
    2 fields
    • defence_daysintegerrequired
    • decision_daysintegerrequired
  • me_defaultobjectrequired
    3 fields
    • lettersbooleanrequired
    • answerbooleanrequired
    • consultbooleanrequired
  • wizardobjectrequired
    4 fields
    • staffbooleanrequired
    • rulesbooleanrequired
    • retentionbooleanrequired
    • aibooleanrequired
  • aiobjectrequired
    5 fields
    • availablebooleanrequired

      This server can run the case assistant (a model and file storage).

    • onbooleanrequired
    • overseeobject[]required

      The people who oversee it (AI Act Art. 26(2)).

      2 fields
      • user_idstringrequired
      • namestringrequired
    • informed_onstring | nullrequired

      The day the company told its workers' representatives and workers that it is used (Art. 26(7)).

    • addendumobjectrequired
      3 fields
      • acceptedbooleanrequired
      • versionstringrequired
      • accepted_versionstring | nullrequired
  • can_editbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/settings.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "accept_addendum": {
    "version": "ai-6",
    "lang": "pt"
  },
  "ai": {
    "on": true,
    "informed_on": "2026-11-20",
    "oversee": [
      "u1"
    ]
  }
}'
Response
{
  "data": {
    "staff": [
      {
        "user_id": "u1",
        "name": "Rui Lopes",
        "email": "rui@acme.example"
      }
    ],
    "packs": {
      "pt": true,
      "es": true
    },
    "convenio": [],
    "cba_double": false,
    "reminder_offsets": [
      7,
      3,
      1,
      0
    ],
    "remind_members": false,
    "retention": {
      "dismissal_months": 15,
      "sanction_months": 12,
      "sanction_years": 5,
      "no_sanction_months": 12
    },
    "retention_ranges": {
      "dismissal_months": [
        15,
        60
      ]
    },
    "eu_defaults": {
      "defence_days": 10,
      "decision_days": 30
    },
    "me_default": {
      "letters": true,
      "answer": true,
      "consult": true
    },
    "wizard": {
      "staff": true,
      "rules": false,
      "retention": false,
      "ai": false
    },
    "ai": {
      "available": true,
      "on": true,
      "oversee": [
        {
          "user_id": "u1",
          "name": "Rui Lopes"
        }
      ],
      "informed_on": "2026-11-20",
      "addendum": {
        "accepted": true,
        "version": "ai-6",
        "accepted_version": "ai-6"
      }
    },
    "can_edit": true
  }
}

AI readings of a case#

POST/v1/relations/reads.listRead

A case's AI readings (newest first, at most 20) with their progress and drafts, the documents of the case file that can be read (PDF, Word, OpenDocument, text, pictures, emails, statements; up to 25 documents and 600 pages a reading; the person's answer and statements picked by default), whether reading is available (reason: unavailable on this server, off for the company, the AI features addendum not accepted), the company's AI credits and the readings left today (20 a case, 50 a user, 300 a company). The case team only. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_reads_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

Returns

9 fields
  • case_idstringrequired
  • availablebooleanrequired
  • reason"unavailable" | "off" | "addendum"required
  • can_startbooleanrequired
  • creditsobjectrequired
    2 fields
    • leftinteger | nullrequired

      null: unlimited or not counted.

    • per_10_scanned_pages1required
  • left_todayintegerrequired
  • documentsobject[]required
    8 fields
    • item_idstringrequired
    • doc_nostringrequired
    • labelstringrequired
    • rolestringrequired
    • kindstring (enum)required

      One of: pdf, word, odt, text, image, email, statement.

    • pagesinteger | nullrequired

      Pages (PDF) or an estimate (other documents).

    • readablebooleanrequired
    • suggestedbooleanrequired

      The person's answer (defence) and statements: picked by default.

  • readingsobject[]required
    13 fields
    • idstringrequired
    • case_idstringrequired
    • status"queued" | "reading" | "reducing" | "done" | "failed" | "cancelled"required
    • failurestring (enum)required

      One of: credits, unreadable, model, cancelled, unavailable, switched_off, timeout.

    • progressobjectrequired
      4 fields
      • doneintegerrequired
      • totalintegerrequired
      • unit"page" | "para" | "mixed"required
      • extractingintegerrequired

        Documents still being opened.

    • sourcesobject[]required
      9 fields
      • item_idstringrequired
      • doc_nostringrequired
      • labelstringrequired
      • kindstring (enum)required

        One of: pdf, word, odt, text, image, email, statement.

      • pagesinteger | nullrequired
      • status"pending" | "ready" | "unreadable"required
      • reason"type" | "damaged" | "empty" | "too_long"required
      • unitsintegerrequired
      • ocr_unitsintegerrequired
    • creditsobjectrequired
      2 fields
      • estimateintegerrequired
      • usedintegerrequired
    • modelstringrequired
    • prompt_vstringrequired
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • created_atstringrequired
    • finished_atstring | nullrequired
    • outputobject | nullrequired
      15 fields
      • idstringrequired
      • status"draft" | "used" | "discarded"required
      • ai_generatedtruerequired

        An AI draft: a person checks it against the pages.

      • summaryobject[]required

        At most 1,500 words, a citation on every sentence, ordered by the charged facts then general points.

        3 fields
        • textstringrequired
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • fact_idstring | nullrequired
      • summary_editedstring | nullrequired

        The team's own wording of the summary, when edited.

      • argumentsobject[]required
        9 fields
        • idstringrequired
        • textstringrequired
        • categorystring (enum)required

          One of: procedural, deadline, facts_denied, justification_health, justification_family, justification_force_majeure, justification_transport, justification_other, proportionality, discrimination_retaliation, evidence_missing, other.

        • fact_idsstring[]required
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • quotesobject[]required
          3 fields
          • citestringrequired
          • textstringrequired
          • foundbooleanrequired
        • timesintegerrequired

          How many times the point is made.

        • citation_foundbooleanrequired

          false: no citation could be checked ("citation not found").

        • answeredbooleanrequired
      • stepsobject[]required
        10 fields
        • idstringrequired
        • kind"witness" | "document" | "expert" | "other"required
        • textstringrequired
        • witnessstring | nullrequired
        • for_fact_idsstring[]required
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • timesintegerrequired
        • status"open" | "done" | "refused" | "not_needed"required
        • reasonstring | nullrequired
        • beyond_capbooleanrequired

          Portugal: beyond 3 witnesses a fact or 10 in total (CT 356(4)).

      • attachmentsobject[]required
        3 fields
        • idstringrequired
        • textstringrequired
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • coverageobjectrequired
        7 fields
        • unitsintegerrequired
        • usedintegerrequired
        • unusedobject[]required

          Pages or paragraphs no item came from: open them.

          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • ocr_failedobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • not_readobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • unreadableobject[]required
          2 fields
          • docstringrequired
          • reason"type" | "damaged" | "empty" | "too_long"required
        • truncatedobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
      • guardobjectrequired
        5 fields
        • cites_droppedintegerrequired
        • quotes_droppedintegerrequired
        • items_droppedintegerrequired
        • sentences_droppedintegerrequired
        • outcome_droppedintegerrequired
      • mergedbooleanrequired

        false: the merge failed; arguments were merged by code and there is no summary.

      • truncatedobject | nullrequired

        The lists were cut to keep the draft under its size limit: how many there were.

        2 fields
        • argumentsintegerrequired
        • stepsintegerrequired
      • modelstringrequired
      • prompt_vstringrequired
      • created_atstringrequired
  • modelstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/reads.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1"}'
Response
{
  "data": {
    "case_id": "c1",
    "available": true,
    "reason": null,
    "can_start": true,
    "credits": {
      "left": 61200,
      "per_10_scanned_pages": 1
    },
    "left_today": 19,
    "documents": [
      {
        "item_id": "i2",
        "doc_no": "D-2",
        "label": "defence.pdf",
        "role": "defence",
        "kind": "pdf",
        "pages": 48,
        "readable": true,
        "suggested": true
      }
    ],
    "readings": [
      {
        "id": "rd1",
        "case_id": "c1",
        "status": "done",
        "failure": null,
        "progress": {
          "done": 48,
          "total": 48,
          "unit": "page",
          "extracting": 0
        },
        "sources": [
          {
            "item_id": "i2",
            "doc_no": "D-2",
            "label": "defence.pdf",
            "kind": "pdf",
            "pages": 48,
            "status": "ready",
            "reason": null,
            "units": 48,
            "ocr_units": 0
          }
        ],
        "credits": {
          "estimate": 11,
          "used": 9
        },
        "model": "gemini-3.5-flash",
        "prompt_v": "case-read-1",
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "created_at": "2026-11-23T10:00:00.000Z",
        "finished_at": "2026-11-23T10:05:00.000Z",
        "output": {
          "id": "o1",
          "status": "draft",
          "ai_generated": true,
          "summary": [
            {
              "text": "The employee says the absence on 3 November was due to health reasons, with a medical certificate.",
              "cites": [
                "D-2 p. 3",
                "D-2 p. 41"
              ],
              "fact_id": "f1"
            }
          ],
          "summary_edited": null,
          "arguments": [
            {
              "id": "a1",
              "text": "Health reasons on 3 November (a medical certificate).",
              "category": "justification_health",
              "fact_ids": [
                "f1"
              ],
              "cites": [
                "D-2 p. 3",
                "D-2 p. 41"
              ],
              "quotes": [
                {
                  "cite": "D-2 p. 3",
                  "text": "estive doente no dia 3",
                  "found": true
                }
              ],
              "times": 2,
              "citation_found": true,
              "answered": false
            }
          ],
          "steps": [
            {
              "id": "s1",
              "kind": "witness",
              "text": "Hear Maria Silva about 3 November.",
              "witness": "Maria Silva",
              "for_fact_ids": [
                "f1"
              ],
              "cites": [
                "D-2 p. 9"
              ],
              "times": 1,
              "status": "open",
              "reason": null,
              "beyond_cap": false
            }
          ],
          "attachments": [
            {
              "id": "d1",
              "text": "Medical certificate",
              "cites": [
                "D-2 p. 41"
              ]
            }
          ],
          "coverage": {
            "units": 48,
            "used": 30,
            "unused": [
              {
                "doc": "D-2",
                "kind": "page",
                "from": 42,
                "to": 48
              }
            ],
            "ocr_failed": [],
            "not_read": [],
            "unreadable": [],
            "truncated": []
          },
          "guard": {
            "cites_dropped": 0,
            "quotes_dropped": 0,
            "items_dropped": 0,
            "sentences_dropped": 0,
            "outcome_dropped": 0
          },
          "merged": true,
          "truncated": null,
          "model": "gemini-3.5-flash",
          "prompt_v": "case-read-1",
          "created_at": "2026-11-23T10:05:00.000Z"
        }
      }
    ],
    "model": "gemini-3.5-flash"
  }
}

Read case documents with AI#

POST/v1/relations/reads.startWrite

Starts an AI reading of documents in a case file (item_ids; default the person's answer and statements): the text of each page (scanned pages by Google Cloud Document AI in the EU) goes, about 15 pages at a time, to a language model on Google Cloud Vertex AI in the EU, then one call merges what was found. The result is a draft for the team: a summary in which every sentence cites its pages (at most 1,500 words), the arguments (with how many times each is made, linked to the charged facts) and the evidence steps asked for, every quote checked word for word against its page by Bizisy, and the pages that gave nothing. It never proposes a finding, an outcome or a sanction and never assesses the person. It runs in the background (minutes for a long answer): follow it with relations.reads.get. Credits: a dry run gives the estimate and the balance; each step holds its worst case first; about 1 credit per 5 pages of text, +1 per 10 scanned pages; a reading that fails charges nothing. One reading at a time per case; at most 25 documents and 600 pages; 20 a case, 50 a user and 300 a company a day. The lead and members, when the company switched AI reading on and an owner accepted the AI features addendum for it. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_reads_start 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

  • case_idstringrequired

    1–64 characters.

  • item_idsstring[]

    Default: the person's answer and statements.

    1–64 characters. Up to 25 items.

Returns

  • case_idstringrequired
  • readingobject | nullrequired

    null on a dry run.

    13 fields
    • idstringrequired
    • case_idstringrequired
    • status"queued" | "reading" | "reducing" | "done" | "failed" | "cancelled"required
    • failurestring (enum)required

      One of: credits, unreadable, model, cancelled, unavailable, switched_off, timeout.

    • progressobjectrequired
      4 fields
      • doneintegerrequired
      • totalintegerrequired
      • unit"page" | "para" | "mixed"required
      • extractingintegerrequired

        Documents still being opened.

    • sourcesobject[]required
      9 fields
      • item_idstringrequired
      • doc_nostringrequired
      • labelstringrequired
      • kindstring (enum)required

        One of: pdf, word, odt, text, image, email, statement.

      • pagesinteger | nullrequired
      • status"pending" | "ready" | "unreadable"required
      • reason"type" | "damaged" | "empty" | "too_long"required
      • unitsintegerrequired
      • ocr_unitsintegerrequired
    • creditsobjectrequired
      2 fields
      • estimateintegerrequired
      • usedintegerrequired
    • modelstringrequired
    • prompt_vstringrequired
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • created_atstringrequired
    • finished_atstring | nullrequired
    • outputobject | nullrequired
      15 fields
      • idstringrequired
      • status"draft" | "used" | "discarded"required
      • ai_generatedtruerequired

        An AI draft: a person checks it against the pages.

      • summaryobject[]required

        At most 1,500 words, a citation on every sentence, ordered by the charged facts then general points.

        3 fields
        • textstringrequired
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • fact_idstring | nullrequired
      • summary_editedstring | nullrequired

        The team's own wording of the summary, when edited.

      • argumentsobject[]required
        9 fields
        • idstringrequired
        • textstringrequired
        • categorystring (enum)required

          One of: procedural, deadline, facts_denied, justification_health, justification_family, justification_force_majeure, justification_transport, justification_other, proportionality, discrimination_retaliation, evidence_missing, other.

        • fact_idsstring[]required
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • quotesobject[]required
          3 fields
          • citestringrequired
          • textstringrequired
          • foundbooleanrequired
        • timesintegerrequired

          How many times the point is made.

        • citation_foundbooleanrequired

          false: no citation could be checked ("citation not found").

        • answeredbooleanrequired
      • stepsobject[]required
        10 fields
        • idstringrequired
        • kind"witness" | "document" | "expert" | "other"required
        • textstringrequired
        • witnessstring | nullrequired
        • for_fact_idsstring[]required
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

        • timesintegerrequired
        • status"open" | "done" | "refused" | "not_needed"required
        • reasonstring | nullrequired
        • beyond_capbooleanrequired

          Portugal: beyond 3 witnesses a fact or 10 in total (CT 356(4)).

      • attachmentsobject[]required
        3 fields
        • idstringrequired
        • textstringrequired
        • citesstring[]required

          Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • coverageobjectrequired
        7 fields
        • unitsintegerrequired
        • usedintegerrequired
        • unusedobject[]required

          Pages or paragraphs no item came from: open them.

          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • ocr_failedobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • not_readobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
        • unreadableobject[]required
          2 fields
          • docstringrequired
          • reason"type" | "damaged" | "empty" | "too_long"required
        • truncatedobject[]required
          4 fields
          • docstringrequired
          • kind"page" | "para"required
          • fromintegerrequired
          • tointegerrequired
      • guardobjectrequired
        5 fields
        • cites_droppedintegerrequired
        • quotes_droppedintegerrequired
        • items_droppedintegerrequired
        • sentences_droppedintegerrequired
        • outcome_droppedintegerrequired
      • mergedbooleanrequired

        false: the merge failed; arguments were merged by code and there is no summary.

      • truncatedobject | nullrequired

        The lists were cut to keep the draft under its size limit: how many there were.

        2 fields
        • argumentsintegerrequired
        • stepsintegerrequired
      • modelstringrequired
      • prompt_vstringrequired
      • created_atstringrequired
  • estimateintegerrequired
  • pagesintegerrequired
  • credits_leftinteger | nullrequired
  • documentsstring[]required

    The case document numbers to be read.

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/reads.start \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","item_ids":["i2"]}'
Response
{
  "data": {
    "case_id": "c1",
    "reading": {
      "id": "rd1",
      "case_id": "c1",
      "status": "queued",
      "failure": null,
      "progress": {
        "done": 0,
        "total": 48,
        "unit": "page",
        "extracting": 1
      },
      "sources": [
        {
          "item_id": "i2",
          "doc_no": "D-2",
          "label": "defence.pdf",
          "kind": "pdf",
          "pages": 48,
          "status": "ready",
          "reason": null,
          "units": 48,
          "ocr_units": 0
        }
      ],
      "credits": {
        "estimate": 11,
        "used": 9
      },
      "model": "gemini-3.5-flash",
      "prompt_v": "case-read-1",
      "by": {
        "user_id": "u1",
        "name": "Rui Lopes"
      },
      "created_at": "2026-11-23T10:00:00.000Z",
      "finished_at": null,
      "output": null
    },
    "estimate": 11,
    "pages": 48,
    "credits_left": 61200,
    "documents": [
      "D-2"
    ]
  }
}

An AI reading of a case#

POST/v1/relations/reads.getRead

One AI reading: its progress ("page 64 of 148"), the documents it reads and their state, the credits estimated and used, and when done its draft (summary with citations, arguments, evidence steps, attachments, page coverage), marked ai_generated. The case team only. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_reads_get on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

  • read_idstringrequired

    1–64 characters.

Returns

13 fields
  • idstringrequired
  • case_idstringrequired
  • status"queued" | "reading" | "reducing" | "done" | "failed" | "cancelled"required
  • failurestring (enum)required

    One of: credits, unreadable, model, cancelled, unavailable, switched_off, timeout.

  • progressobjectrequired
    4 fields
    • doneintegerrequired
    • totalintegerrequired
    • unit"page" | "para" | "mixed"required
    • extractingintegerrequired

      Documents still being opened.

  • sourcesobject[]required
    9 fields
    • item_idstringrequired
    • doc_nostringrequired
    • labelstringrequired
    • kindstring (enum)required

      One of: pdf, word, odt, text, image, email, statement.

    • pagesinteger | nullrequired
    • status"pending" | "ready" | "unreadable"required
    • reason"type" | "damaged" | "empty" | "too_long"required
    • unitsintegerrequired
    • ocr_unitsintegerrequired
  • creditsobjectrequired
    2 fields
    • estimateintegerrequired
    • usedintegerrequired
  • modelstringrequired
  • prompt_vstringrequired
  • byobjectrequired
    2 fields
    • user_idstringrequired
    • namestringrequired
  • created_atstringrequired
  • finished_atstring | nullrequired
  • outputobject | nullrequired
    15 fields
    • idstringrequired
    • status"draft" | "used" | "discarded"required
    • ai_generatedtruerequired

      An AI draft: a person checks it against the pages.

    • summaryobject[]required

      At most 1,500 words, a citation on every sentence, ordered by the charged facts then general points.

      3 fields
      • textstringrequired
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • fact_idstring | nullrequired
    • summary_editedstring | nullrequired

      The team's own wording of the summary, when edited.

    • argumentsobject[]required
      9 fields
      • idstringrequired
      • textstringrequired
      • categorystring (enum)required

        One of: procedural, deadline, facts_denied, justification_health, justification_family, justification_force_majeure, justification_transport, justification_other, proportionality, discrimination_retaliation, evidence_missing, other.

      • fact_idsstring[]required
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • quotesobject[]required
        3 fields
        • citestringrequired
        • textstringrequired
        • foundbooleanrequired
      • timesintegerrequired

        How many times the point is made.

      • citation_foundbooleanrequired

        false: no citation could be checked ("citation not found").

      • answeredbooleanrequired
    • stepsobject[]required
      10 fields
      • idstringrequired
      • kind"witness" | "document" | "expert" | "other"required
      • textstringrequired
      • witnessstring | nullrequired
      • for_fact_idsstring[]required
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • timesintegerrequired
      • status"open" | "done" | "refused" | "not_needed"required
      • reasonstring | nullrequired
      • beyond_capbooleanrequired

        Portugal: beyond 3 witnesses a fact or 10 in total (CT 356(4)).

    • attachmentsobject[]required
      3 fields
      • idstringrequired
      • textstringrequired
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

    • coverageobjectrequired
      7 fields
      • unitsintegerrequired
      • usedintegerrequired
      • unusedobject[]required

        Pages or paragraphs no item came from: open them.

        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • ocr_failedobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • not_readobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • unreadableobject[]required
        2 fields
        • docstringrequired
        • reason"type" | "damaged" | "empty" | "too_long"required
      • truncatedobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
    • guardobjectrequired
      5 fields
      • cites_droppedintegerrequired
      • quotes_droppedintegerrequired
      • items_droppedintegerrequired
      • sentences_droppedintegerrequired
      • outcome_droppedintegerrequired
    • mergedbooleanrequired

      false: the merge failed; arguments were merged by code and there is no summary.

    • truncatedobject | nullrequired

      The lists were cut to keep the draft under its size limit: how many there were.

      2 fields
      • argumentsintegerrequired
      • stepsintegerrequired
    • modelstringrequired
    • prompt_vstringrequired
    • created_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/reads.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1","read_id":"rd1"}'
Response
{
  "data": {
    "id": "rd1",
    "case_id": "c1",
    "status": "done",
    "failure": null,
    "progress": {
      "done": 48,
      "total": 48,
      "unit": "page",
      "extracting": 0
    },
    "sources": [
      {
        "item_id": "i2",
        "doc_no": "D-2",
        "label": "defence.pdf",
        "kind": "pdf",
        "pages": 48,
        "status": "ready",
        "reason": null,
        "units": 48,
        "ocr_units": 0
      }
    ],
    "credits": {
      "estimate": 11,
      "used": 9
    },
    "model": "gemini-3.5-flash",
    "prompt_v": "case-read-1",
    "by": {
      "user_id": "u1",
      "name": "Rui Lopes"
    },
    "created_at": "2026-11-23T10:00:00.000Z",
    "finished_at": "2026-11-23T10:05:00.000Z",
    "output": {
      "id": "o1",
      "status": "draft",
      "ai_generated": true,
      "summary": [
        {
          "text": "The employee says the absence on 3 November was due to health reasons, with a medical certificate.",
          "cites": [
            "D-2 p. 3",
            "D-2 p. 41"
          ],
          "fact_id": "f1"
        }
      ],
      "summary_edited": null,
      "arguments": [
        {
          "id": "a1",
          "text": "Health reasons on 3 November (a medical certificate).",
          "category": "justification_health",
          "fact_ids": [
            "f1"
          ],
          "cites": [
            "D-2 p. 3",
            "D-2 p. 41"
          ],
          "quotes": [
            {
              "cite": "D-2 p. 3",
              "text": "estive doente no dia 3",
              "found": true
            }
          ],
          "times": 2,
          "citation_found": true,
          "answered": false
        }
      ],
      "steps": [
        {
          "id": "s1",
          "kind": "witness",
          "text": "Hear Maria Silva about 3 November.",
          "witness": "Maria Silva",
          "for_fact_ids": [
            "f1"
          ],
          "cites": [
            "D-2 p. 9"
          ],
          "times": 1,
          "status": "open",
          "reason": null,
          "beyond_cap": false
        }
      ],
      "attachments": [
        {
          "id": "d1",
          "text": "Medical certificate",
          "cites": [
            "D-2 p. 41"
          ]
        }
      ],
      "coverage": {
        "units": 48,
        "used": 30,
        "unused": [
          {
            "doc": "D-2",
            "kind": "page",
            "from": 42,
            "to": 48
          }
        ],
        "ocr_failed": [],
        "not_read": [],
        "unreadable": [],
        "truncated": []
      },
      "guard": {
        "cites_dropped": 0,
        "quotes_dropped": 0,
        "items_dropped": 0,
        "sentences_dropped": 0,
        "outcome_dropped": 0
      },
      "merged": true,
      "truncated": null,
      "model": "gemini-3.5-flash",
      "prompt_v": "case-read-1",
      "created_at": "2026-11-23T10:05:00.000Z"
    }
  }
}

Cancel an AI reading#

POST/v1/relations/reads.cancelWrite

Stops an AI reading in progress. The parts already read stay charged (what the model read cost); steps in flight are not charged. The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_reads_cancel 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

  • case_idstringrequired

    1–64 characters.

  • read_idstringrequired

    1–64 characters.

Returns

  • case_idstringrequired
  • cancelledbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/reads.cancel \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"case_id":"c1","read_id":"rd1"}'
Response
{
  "data": {
    "case_id": "c1",
    "cancelled": true
  }
}

Work with an AI reading's draft#

POST/v1/relations/ai.updateWrite

What the team does with an AI reading's draft, recorded in the AI log: tick arguments as answered (arguments: [{id, answered}]), set each evidence step asked for to done, refused (reason required: the written reasons, CT 356(1)) or not needed (steps: [{id, status, reason}]), keep its own wording of the summary (summary_edited; the edit ratio is logged), and say whether the draft was used or discarded (status). The lead and members. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_ai_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

  • case_idstringrequired

    1–64 characters.

  • output_idstringrequired

    1–64 characters.

  • argumentsobject[]

    Up to 500 items.

    2 fields
    • idstringrequired

      Up to 20 characters.

    • answeredbooleanrequired
  • stepsobject[]

    Up to 500 items.

    3 fields
    • idstringrequired

      Up to 20 characters.

    • status"open" | "done" | "refused" | "not_needed"required
    • reasonstring | null

      Up to 2000 characters. Default null.

  • summary_editedstring | null

    Up to 20000 characters.

  • status"draft" | "used" | "discarded"

Returns

  • case_idstringrequired
  • outputobjectrequired
    15 fields
    • idstringrequired
    • status"draft" | "used" | "discarded"required
    • ai_generatedtruerequired

      An AI draft: a person checks it against the pages.

    • summaryobject[]required

      At most 1,500 words, a citation on every sentence, ordered by the charged facts then general points.

      3 fields
      • textstringrequired
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • fact_idstring | nullrequired
    • summary_editedstring | nullrequired

      The team's own wording of the summary, when edited.

    • argumentsobject[]required
      9 fields
      • idstringrequired
      • textstringrequired
      • categorystring (enum)required

        One of: procedural, deadline, facts_denied, justification_health, justification_family, justification_force_majeure, justification_transport, justification_other, proportionality, discrimination_retaliation, evidence_missing, other.

      • fact_idsstring[]required
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • quotesobject[]required
        3 fields
        • citestringrequired
        • textstringrequired
        • foundbooleanrequired
      • timesintegerrequired

        How many times the point is made.

      • citation_foundbooleanrequired

        false: no citation could be checked ("citation not found").

      • answeredbooleanrequired
    • stepsobject[]required
      10 fields
      • idstringrequired
      • kind"witness" | "document" | "expert" | "other"required
      • textstringrequired
      • witnessstring | nullrequired
      • for_fact_idsstring[]required
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

      • timesintegerrequired
      • status"open" | "done" | "refused" | "not_needed"required
      • reasonstring | nullrequired
      • beyond_capbooleanrequired

        Portugal: beyond 3 witnesses a fact or 10 in total (CT 356(4)).

    • attachmentsobject[]required
      3 fields
      • idstringrequired
      • textstringrequired
      • citesstring[]required

        Citations: "D-3 p. 12" (a page) or "D-3 ¶ 132" (a paragraph), each checked by code against the document.

    • coverageobjectrequired
      7 fields
      • unitsintegerrequired
      • usedintegerrequired
      • unusedobject[]required

        Pages or paragraphs no item came from: open them.

        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • ocr_failedobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • not_readobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
      • unreadableobject[]required
        2 fields
        • docstringrequired
        • reason"type" | "damaged" | "empty" | "too_long"required
      • truncatedobject[]required
        4 fields
        • docstringrequired
        • kind"page" | "para"required
        • fromintegerrequired
        • tointegerrequired
    • guardobjectrequired
      5 fields
      • cites_droppedintegerrequired
      • quotes_droppedintegerrequired
      • items_droppedintegerrequired
      • sentences_droppedintegerrequired
      • outcome_droppedintegerrequired
    • mergedbooleanrequired

      false: the merge failed; arguments were merged by code and there is no summary.

    • truncatedobject | nullrequired

      The lists were cut to keep the draft under its size limit: how many there were.

      2 fields
      • argumentsintegerrequired
      • stepsintegerrequired
    • modelstringrequired
    • prompt_vstringrequired
    • created_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/ai.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_id": "c1",
  "output_id": "o1",
  "steps": [
    {
      "id": "s1",
      "status": "refused",
      "reason": "Not present that day."
    }
  ],
  "status": "used"
}'
Response
{
  "data": {
    "case_id": "c1",
    "output": {
      "id": "o1",
      "status": "draft",
      "ai_generated": true,
      "summary": [
        {
          "text": "The employee says the absence on 3 November was due to health reasons, with a medical certificate.",
          "cites": [
            "D-2 p. 3",
            "D-2 p. 41"
          ],
          "fact_id": "f1"
        }
      ],
      "summary_edited": null,
      "arguments": [
        {
          "id": "a1",
          "text": "Health reasons on 3 November (a medical certificate).",
          "category": "justification_health",
          "fact_ids": [
            "f1"
          ],
          "cites": [
            "D-2 p. 3",
            "D-2 p. 41"
          ],
          "quotes": [
            {
              "cite": "D-2 p. 3",
              "text": "estive doente no dia 3",
              "found": true
            }
          ],
          "times": 2,
          "citation_found": true,
          "answered": true
        }
      ],
      "steps": [
        {
          "id": "s1",
          "kind": "witness",
          "text": "Hear Maria Silva about 3 November.",
          "witness": "Maria Silva",
          "for_fact_ids": [
            "f1"
          ],
          "cites": [
            "D-2 p. 9"
          ],
          "times": 1,
          "status": "open",
          "reason": null,
          "beyond_cap": false
        }
      ],
      "attachments": [
        {
          "id": "d1",
          "text": "Medical certificate",
          "cites": [
            "D-2 p. 41"
          ]
        }
      ],
      "coverage": {
        "units": 48,
        "used": 30,
        "unused": [
          {
            "doc": "D-2",
            "kind": "page",
            "from": 42,
            "to": 48
          }
        ],
        "ocr_failed": [],
        "not_read": [],
        "unreadable": [],
        "truncated": []
      },
      "guard": {
        "cites_dropped": 0,
        "quotes_dropped": 0,
        "items_dropped": 0,
        "sentences_dropped": 0,
        "outcome_dropped": 0
      },
      "merged": true,
      "truncated": null,
      "model": "gemini-3.5-flash",
      "prompt_v": "case-read-1",
      "created_at": "2026-11-23T10:05:00.000Z"
    }
  }
}

AI log of a case#

POST/v1/relations/ai.logRead

Every use of the case assistant in a case (AI Act Art. 12): who, when, which documents (numbers and SHA-256), the model and prompt version, the outcome, the credits, and what the team did with the draft (used, edited with the edit ratio, discarded). Kept with the case and at least six months. The case team only. In the app only.

Web app only
Refused for API keys and connected apps. The case assistant works only in the Bizisy app, for the case team: a case is confidential to its team.
MCP tool
relations_ai_log on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • case_idstringrequired

    1–64 characters.

Returns

  • case_idstringrequired
  • rowsobject[]required
    15 fields
    • idstringrequired
    • atstringrequired
    • byobjectrequired
      2 fields
      • user_idstringrequired
      • namestringrequired
    • run"reading"required
    • inputsobject[]required
      3 fields
      • doc_nostringrequired
      • sha256stringrequired
      • unitsintegerrequired
    • modelstringrequired
    • reduce_modelstringrequired
    • prompt_vstringrequired
    • outcome"running" | "done" | "failed" | "cancelled"required
    • creditsintegerrequired
    • human_action"used" | "edited" | "discarded"required
    • edit_rationumber | nullrequired
    • acted_bystring | nullrequired
    • acted_atstring | nullrequired
    • keep_untilstringrequired

Errors

validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal

curl
curl https://api.bizisy.com/v1/relations/ai.log \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id":"c1"}'
Response
{
  "data": {
    "case_id": "c1",
    "rows": [
      {
        "id": "rd1",
        "at": "2026-11-23T10:00:00.000Z",
        "by": {
          "user_id": "u1",
          "name": "Rui Lopes"
        },
        "run": "reading",
        "inputs": [
          {
            "doc_no": "D-2",
            "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "units": 48
          }
        ],
        "model": "gemini-3.5-flash",
        "reduce_model": "gemini-3.5-flash",
        "prompt_v": "case-read-1",
        "outcome": "done",
        "credits": 9,
        "human_action": null,
        "edit_ratio": null,
        "acted_by": null,
        "acted_at": null,
        "keep_until": "2027-05-23"
      }
    ]
  }
}

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

Developer docs