Skip to content

API reference

Cases

The case list: everything that needs HR from every module, each with its evidence and a suggested fix to run; snooze cases or hand them to a colleague.

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

List cases that need HR#

POST/v1/org/cases.listRead

The case list: one list of what needs HR now, gathered from every module that knows it — change requests waiting for your decision (approval, with the request id; position_approval: positions to open whose approval step is yours, decided in Bizisy, Approvals; requests_waiting: time off, time corrections, offers, shift requests and document templates, as counts), first days not prepared (first_day), joiners missing payroll or contact details (missing_details: which fields, never their values; owners, admins and HR in the app only), fixed-term contracts ending within 60 days with the legal notice deadline where the country has one (contract_notice; date = the deadline), probation ends, people to tell about their last day, offboarding, open positions reporting to a leaver, overdue checklist tasks, records that contradict themselves (data_issue), and, when the modules are on, overdue mandatory training (training_overdue), signature requests waiting or failed, overdue document requests, prepared documents with a legal deadline and statutory notices due. Each case: kind, person (public tier) and team, date (deadline; overdue when passed), label (the course, document category or task), facts (the evidence), fix (a suggested action and input to run — the server checks every rule again; cases with the same action and merge key can be handled in one call) and link (where to fix it in Bizisy). view: open (default; snoozed left out), snoozed or mine (handed to you). Filter by kinds, module, team_id, person_id, q, overdue; sort by deadline (default), kind, person or team; a page of up to 1000 (offset). open, overdue and nearest are for the whole list. Cases leave once the data changes. Owners, admins and HR; never a custom role.

Who can call it
Manage key owner admin hr
Keys and apps
Joiners missing payroll details (missing_details) are left out.
MCP tool
org_cases_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • view"open" | "snoozed" | "mine"

    open: what needs HR now (snoozed cases left out); snoozed: only snoozed ones; mine: handed to you.

    Default "open".

  • kindsstring (enum)[]

    One of: approval, requests_waiting, position_approval, wave_approval, first_day, missing_details, contract_notice, probation_ends, tell_leaver, offboard, move_roles, training_overdue, signature_pending, signature_failed, document_request_overdue, documents_prepared, checklist_overdue, statutory_notice, data_issue. Up to 19 items.

  • modulestring

    1–40 characters.

  • team_idstring
  • person_idstring
  • qstring

    Words in the person's name, title or the case label.

    Up to 100 characters.

  • overdueboolean

    Only cases whose date passed.

  • sort"deadline" | "kind" | "person" | "team"

    Default "deadline".

  • limitinteger

    From 1 to 1000. Default 200.

  • offsetinteger

    At least 0. Default 0.

Returns

9 fields
  • as_ofstringrequired
  • totalintegerrequired

    Cases matching the filters (items is one page of them).

  • openintegerrequired

    Every open case (not snoozed), whatever the filters: the header count.

  • overdueintegerrequired

    Open cases whose date passed.

  • neareststring | nullrequired

    The nearest date among open cases that are not overdue yet (YYYY-MM-DD).

  • next_offsetinteger | nullrequired
  • facetsobjectrequired
    5 fields
    • kindsobject[]required
      2 fields
      • countintegerrequired
      • kindstring (enum)required

        One of: approval, requests_waiting, position_approval, wave_approval, first_day, missing_details, contract_notice, probation_ends, tell_leaver, offboard, move_roles, training_overdue, signature_pending, signature_failed, document_request_overdue, documents_prepared, checklist_overdue, statutory_notice, data_issue.

    • modulesobject[]required
      2 fields
      • countintegerrequired
      • modulestringrequired
    • teamsobject[]required
      3 fields
      • countintegerrequired
      • idstring | nullrequired
      • namestringrequired
    • snoozedintegerrequired
    • mineintegerrequired
  • truncatedstring[]required
  • itemsobject[]required
    15 fields
    • idstringrequired
    • kindstring (enum)required

      One of: approval, requests_waiting, position_approval, wave_approval, first_day, missing_details, contract_notice, probation_ends, tell_leaver, offboard, move_roles, training_overdue, signature_pending, signature_failed, document_request_overdue, documents_prepared, checklist_overdue, statutory_notice, data_issue.

    • person_idstring | nullrequired
    • datestring | nullrequired
    • labelstring | nullrequired
    • countinteger | nullrequired
    • factsobject[]required
      2 fields
      • keystringrequired
      • valuestring | number | "null"required
    • fixobject | nullrequired
      4 fields
      • actionstringrequired
      • inputobjectrequired
      • mergestring | nullrequired
      • verb"remind" | "retry" | "invite" | "apply" | "done"required
    • linkstring | nullrequired
    • modulestringrequired
    • personobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • teamobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • overduebooleanrequired
    • snoozed_untilstring | nullrequired
    • assigneeobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/cases.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "view": "snoozed",
  "kinds": [
    "training_overdue",
    "first_day"
  ],
  "team_id": "u2",
  "q": "rui",
  "overdue": true,
  "sort": "kind",
  "limit": 50,
  "offset": 50
}'
Response
{
  "data": {
    "as_of": "2026-10-04",
    "total": 1,
    "open": 1,
    "overdue": 1,
    "nearest": null,
    "next_offset": null,
    "facets": {
      "kinds": [
        {
          "kind": "training_overdue",
          "count": 1
        }
      ],
      "modules": [
        {
          "module": "training",
          "count": 1
        }
      ],
      "teams": [
        {
          "id": "u2",
          "name": "Engineering",
          "count": 1
        }
      ],
      "snoozed": 0,
      "mine": 0
    },
    "truncated": [],
    "items": [
      {
        "id": "training_overdue:rl1:p2",
        "kind": "training_overdue",
        "module": "training",
        "person_id": "p2",
        "person": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": null
        },
        "team": {
          "id": "u2",
          "name": "Engineering"
        },
        "date": "2026-09-30",
        "overdue": true,
        "label": "Fire safety",
        "count": null,
        "facts": [
          {
            "key": "course",
            "value": "Fire safety"
          },
          {
            "key": "due_on",
            "value": "2026-09-30"
          },
          {
            "key": "valid_until",
            "value": null
          }
        ],
        "fix": {
          "action": "training.compliance.remind",
          "input": {
            "rule_id": "rl1",
            "person_ids": [
              "p2"
            ]
          },
          "merge": "person_ids",
          "verb": "remind"
        },
        "link": "/training?tab=compliance&rule=rl1",
        "snoozed_until": null,
        "assignee": null
      }
    ]
  }
}

Snooze or hand over cases#

POST/v1/org/cases.updateWrite

Snoozes cases until a day (snoozed_until YYYY-MM-DD, after today; null wakes them) and/or hands them to a member who handles cases (assignee_id: a user id of an owner, admin or HR member from platform_members_list; null takes the hand-off back). case_ids from org_cases_list, at most 500 at once. A snoozed case comes back on its day, or at once if it changes. Nothing about the person changes and nobody is emailed. Owners, admins and HR in the app or over MCP; never a custom role.

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

Input

  • case_idsstring[]required

    1–300 characters. 1–500 items.

  • snoozed_untilstring | null
  • assignee_idstring | null

Returns

  • updatedintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/cases.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "case_ids": [
    "first_day:p3"
  ],
  "assignee_id": "user-1",
  "snoozed_until": null
}'
Response
{
  "data": {
    "updated": 1
  }
}

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

Developer docs