Skip to content

API reference

Exports, reports and erasure

People as CSV, a person's data for an access request, the headcount, span of control and data quality reports, and erasing a former employee.

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

Erase a former employee's personal data#

POST/v1/org/people.eraseDestructive

Anonymises a person whose employment has fully ended (every job row ended by today; none current or scheduled): names become 'Erased person', the work email becomes a placeholder, contact, private and custom fields (sex included, and the job custom fields on their job rows) and payroll identifiers are cleared, person custom fields that name them (on colleagues, jobs, teams and positions) are cleared, the profile photo, documents (with their files), pay history, variable pay imported for draft pay gap reports, reminder records, approval requests about them and their checklists (and their comments on others' tasks) and their change history are deleted, invite emails, email delivery records, webhook payloads sent about them and termination reasons are scrubbed. Job rows (dates, titles and contract terms) are kept, anonymised, for history; open invites are revoked and any login is disabled. Irreversible. Owners and admins only; you cannot erase yourself.

Who can call it
Manage key owner admin
MCP tool
org_people_erase 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

Returns

  • person_idstringrequired
  • erasedtruerequired
  • closed_requestsintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/people.erase \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"person_id":"p1"}'
Response
{
  "data": {
    "person_id": "p1",
    "erased": true,
    "closed_requests": 0
  }
}

Export people as CSV#

POST/v1/org/people.export_csvRead

Exports people as a CSV file (UTF-8, comma-separated by default; delimiter ";" suits Excel in most of Europe; one row per person) as of a date: names, work email and phone, status, start date, current job (title, team, manager, location, legal entity, employment type, FTE, contract terms) and active custom fields (archived fields are left out; personal-data exports include them). status defaults to active + pre_hire ("all" includes leavers). include_private adds personal contact details, birthday, address, tax id, social security number, IBAN and private custom fields: owners, admins and HR in the app only, never over MCP or an API key. Pay is not included.

Who can call it
Manage key owner admin hr
Keys and apps
include_private is refused.
MCP tool
org_people_export_csv on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • as_ofstring
  • status"active" | "pre_hire" | "terminated" | "invited" | "all"
  • include_privateboolean
  • delimiter"," | ";"
  • group_idstring

    Only members of a saved group (org_groups_list), today.

Returns

  • filenamestringrequired
  • csvstringrequired
  • rowsintegerrequired
  • columnsstring[]required

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/people.export_csv \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"all","as_of":"2026-10-04","delimiter":";"}'
Response
{
  "data": {
    "filename": "people-2026-10-04.csv",
    "csv": "given_name,family_name\r\nAna,Ferreira\r\n",
    "rows": 1,
    "columns": [
      "given_name",
      "family_name"
    ]
  }
}

Export a person's data (GDPR access request)#

POST/v1/org/people.export_dataRead

Returns everything Bizisy holds about one person in this organization as JSON, to answer a data access request: profile (all fields, including private and custom), the profile photo (base64), every document of the person (metadata, plus document_files: 5-minute download links the web app puts in one zip), job history, pay history, variable pay imported for a draft pay gap report, their requests about pay levels and the answers, invites, their logins (email, role, sign-in methods), their API keys (names and dates, never secrets), their Activity, open positions they filled or are recorded as replaced in, change requests about them (approvals), their checklists (about them, assigned to them, and their comments), the equipment they hold and held, their time off (bookings and requests with type, note and decisions, balance adjustments), their payroll data (employee number, pay periods they were in, variable pay, net pay, notes about them) and webhook deliveries about them in the last 30 days. Owners, admins and HR, in the app only: it contains private data, so over MCP or an API key it only works for yourself (or use org_me_export_data).

Who can call it
Manage key owner admin hr
Keys and apps
Only for yourself (or use org.me.export_data).
MCP tool
org_people_export_data on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • person_idstringrequired

Returns

61 fields
  • format"bizisy.person-data.v1"required
  • generated_atstringrequired
  • organization_idstringrequired
  • personobjectrequired
  • photoobject | nullrequired
    3 fields
    • content_typestringrequired
    • data_base64stringrequired
    • updated_atstringrequired
  • jobsobject[]required
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • planned_last_dayobject | null

    A last day still ahead (a termination recorded, the day not passed): the day itself, the leaving type and reason, and whether the person has been told. Their own copy has it once they have been told (spec told-about-last-day T3, GDPR art. 15); null: none ahead, or not told yet in their own copy.

    5 fields
    • last_daystringrequired
    • leaving_typestring (enum)required

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • reasonstring | nullrequired
    • toldbooleanrequired

      false: not told yet (HR's export only: their own copy leaves it out until they are told).

    • recorded_atstringrequired
  • payobject[]required
    8 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • amountnumberrequired
    • currencystringrequired
    • period"year" | "month" | "hour"required
    • notestring | nullrequired
    • created_atstringrequired
  • invitesobject[]required
    6 fields
    • emailstringrequired
    • rolestringrequired
    • created_atstringrequired
    • expires_atstringrequired
    • accepted_atstring | nullrequired
    • revoked_atstring | nullrequired
  • loginsobject[]required
  • api_keysobject[]required
  • connected_appsobject[]required
  • dpa_acceptancesobject[]
  • activityobject[]required
  • activity_truncatedbooleanrequired
  • change_historyobject[]required
    8 fields
    • idstringrequired
    • entry_idstringrequired
    • atstringrequired
    • op"insert" | "update" | "delete"required
    • recordobjectrequired
      4 fields
      • kindstringrequired
      • idstringrequired
      • namestring | nullrequired
      • datestring | nullrequired
    • person_idsstring[]required
    • fieldsobject[]required
      6 fields
      • keystringrequired
      • labelstring | nullrequired
      • tier"public" | "job" | "private" | "pay" | "hr"required
      • beforeobjectrequired
        27 fields (one of several shapes)

        Option 1

        • t"text"required
        • vstringrequired

        Option 2

        • t"number"required
        • vnumberrequired

        Option 3

        • t"bool"required
        • vbooleanrequired

        Option 4

        • t"date"required
        • vstringrequired

        Option 5

        • t"datetime"required
        • vstringrequired

        Option 6

        • t"money"required
        • amountnumberrequired
        • currencystringrequired
        • periodstring | nullrequired

        Option 7

        • t"ref"required
        • kindstring (enum)required

          One of: person, unit, location, title, entity, position, family, level, category, field, document, checklist.

        • idstringrequired
        • namestring | nullrequired

        Option 8

        • t"enum"required
        • setstringrequired
        • vstringrequired

        Option 9

        • t"list"required
        • itemsany[]required

        Option 10

        • t"file"required
        • namestring | nullrequired
        • sizenumber | nullrequired

        Option 11

        • t"secret"required
      • afterobjectrequired
        27 fields (one of several shapes)

        Option 1

        • t"text"required
        • vstringrequired

        Option 2

        • t"number"required
        • vnumberrequired

        Option 3

        • t"bool"required
        • vbooleanrequired

        Option 4

        • t"date"required
        • vstringrequired

        Option 5

        • t"datetime"required
        • vstringrequired

        Option 6

        • t"money"required
        • amountnumberrequired
        • currencystringrequired
        • periodstring | nullrequired

        Option 7

        • t"ref"required
        • kindstring (enum)required

          One of: person, unit, location, title, entity, position, family, level, category, field, document, checklist.

        • idstringrequired
        • namestring | nullrequired

        Option 8

        • t"enum"required
        • setstringrequired
        • vstringrequired

        Option 9

        • t"list"required
        • itemsany[]required

        Option 10

        • t"file"required
        • namestring | nullrequired
        • sizenumber | nullrequired

        Option 11

        • t"secret"required
      • hiddenbooleanrequired
    • truncatedbooleanrequired
  • change_history_truncatedbooleanrequired
  • notificationsobject[]required
    3 fields
    • typestringrequired
    • created_atstringrequired
    • read_atstring | nullrequired
  • home_preferencesobject[]required
    4 fields
    • managestring | nullrequired
    • mestring | nullrequired
    • pinsobjectrequired
      2 fields
      • managestring[]required
      • mestring[]required
    • updated_atstringrequired
  • directory_accountsobject[]required
    3 fields
    • providerstringrequired
    • accountstring | nullrequired
    • excludedbooleanrequired
  • spend_accountsobject[]required

    Their account in each connected spend tool (Pleo, Moss, Payhawk, Spendesk) as Bizisy last read it.

    4 fields
    • toolstringrequired
    • accountstring | nullrequired
    • statestring | nullrequired
    • excludedbooleanrequired
  • recruitingobject[]required

    The recruiting tool application they were hired from (Teamtailor, Greenhouse).

    3 fields
    • toolstringrequired
    • application_idstringrequired
    • received_atstringrequired
  • announcementsobject[]required
    5 fields
    • toolstringrequired
    • kindstringrequired
    • daystringrequired
    • statusstringrequired
    • posted_atstring | nullrequired
  • remindersobject[]required
    3 fields
    • kindstringrequired
    • datestringrequired
    • sent_atstringrequired
  • occupational_health_checkobject | nullrequired

    The dates HR keeps (never a result).

    2 fields
    • last_onstring | nullrequired
    • next_due_set_by_hrstring | nullrequired
  • check_insobjectrequired
    6 fields
    • one_on_onesobject[]required
      7 fields
      • role"person" | "manager"required
      • kindstringrequired
      • withstringrequired
      • cadencestringrequired
      • first_datestringrequired
      • last_heldstring | nullrequired
      • endedbooleanrequired
    • meetingsobject[]required
      3 fields
      • role"person" | "manager"required
      • datestringrequired
      • statusstringrequired
    • pointsobject[]required
      9 fields
      • role"person" | "manager"required
      • kindstringrequired
      • textstringrequired
      • bystringrequired
      • ownerstring | nullrequired
      • duestring | nullrequired
      • done_onstring | nullrequired
      • held_onstring | nullrequired
      • notesstring | nullrequired
    • notesobject[]required
      4 fields
      • datestringrequired
      • textstringrequired
      • written_by"them" | "the other side"required
      • ratingstring | nullrequired
    • quarterlyobject[]required
      3 fields
      • periodstringrequired
      • selfobject | nullrequired
        3 fields
        • answersobject[]required
          3 fields
          • question_idstringrequired
          • questionstringrequired
          • textstringrequired
        • ratinginteger | nullrequired
        • submitted_atstring | nullrequired
      • managerobject | nullrequired
        3 fields
        • answersobject[]required
          3 fields
          • question_idstringrequired
          • questionstringrequired
          • textstringrequired
        • ratinginteger | nullrequired
        • submitted_atstring | nullrequired
    • exemptionsobject[]required
      4 fields
      • statusstringrequired
      • justificationstringrequired
      • untilstring | nullrequired
      • created_atstringrequired
  • company_announcementsobjectrequired

    Announcements published to the person (with when they saw and acknowledged each) and those they posted.

    2 fields
    • receivedobject[]required
      7 fields
      • titlestringrequired
      • published_atstring | nullrequired
      • requires_ackbooleanrequired
      • seen_atstring | nullrequired
      • acknowledged_atstring | nullrequired
      • via"app" | "kiosk"required
      • fingerprintstring | nullrequired
    • postedobject[]required
      4 fields
      • titlestringrequired
      • statusstringrequired
      • created_atstringrequired
      • published_atstring | nullrequired
  • positionsobject[]required
    4 fields
    • idstringrequired
    • titlestringrequired
    • statusstringrequired
    • role"filled" | "replaced"required
  • role_requestsobject[]required
    5 fields
    • titlestringrequired
    • kind"new" | "backfill"required
    • statusstringrequired
    • notestring | nullrequired
    • asked_atstringrequired
  • dotted_linesobject[]required
    6 fields
    • role"person" | "manager"required
    • personstringrequired
    • managerstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • notestring | nullrequired
  • approvalsobject[]required
  • saved_draftsobject[]required
    4 fields
    • processstringrequired
    • labelstringrequired
    • dataobjectrequired
    • saved_atstringrequired
  • groupsobject[]required

    Saved groups whose criteria name the person (wave H D19: the reports of this manager). Membership is computed when used, never stored.

    2 fields
    • namestringrequired
    • named_as"manager"required
  • import_rowsobject[]required

    Rows of import runs (kept 30 days) that name the person: HR's export only.

    6 fields
    • import_idstringrequired
    • rownumberrequired
    • outcomestringrequired
    • appliedbooleanrequired
    • cellsstring[] | nullrequired
    • errorsobject[]required
      2 fields
      • columnstring | nullrequired
      • messagestringrequired
  • start_groupsobject[]

    Start groups the person is in (HR's export).

    2 fields
    • namestringrequired
    • start_datestringrequired
  • move_batchesobject[]

    Batches of job changes that include the person (HR's export; their own once the change is announced).

    5 fields
    • batchstringrequired
    • effective_datestringrequired
    • announce_onstringrequired
    • outcomestringrequired
    • problemstring | nullrequired
  • movesobject[]

    Rows of moves from another HR tool (kept 30 days) about the person: HR's export only.

    6 fields
    • run_idstringrequired
    • kindstringrequired
    • outcomestringrequired
    • appliedbooleanrequired
    • problemsstring[]required
    • expires_atstringrequired
  • checklistsobjectrequired
    5 fields
    • about_youobject[]required
      6 fields
      • namestringrequired
      • kindstringrequired
      • statusstringrequired
      • anchor_datestringrequired
      • started_atstringrequired
      • tasksobject[]required
        6 fields
        • titlestringrequired
        • due_datestringrequired
        • statusstringrequired
        • skip_reasonstring | nullrequired
        • resolved_atstring | nullrequired
        • commentsobject[]required
          3 fields
          • textstringrequired
          • atstringrequired
          • by_youbooleanrequired
    • assigned_to_youobject[]required
      5 fields
      • checkliststringrequired
      • titlestringrequired
      • due_datestringrequired
      • statusstringrequired
      • resolved_atstring | nullrequired
    • your_commentsobject[]required
      4 fields
      • checkliststringrequired
      • taskstringrequired
      • textstringrequired
      • atstringrequired
    • resolved_by_youobject[]required
      5 fields
      • checkliststringrequired
      • taskstringrequired
      • statusstringrequired
      • skip_reasonstring | nullrequired
      • resolved_atstring | nullrequired
    • template_tasksobject[]required
      2 fields
      • templatestringrequired
      • taskstringrequired
  • webhook_deliveriesobject[]required
    4 fields
    • event_typestringrequired
    • endpoint_hoststringrequired
    • created_atstringrequired
    • statusstringrequired
  • integration_linksobject[]required
    5 fields
    • toolstringrequired
    • entitystringrequired
    • external_idstringrequired
    • external_urlstring | nullrequired
    • linked_atstringrequired
  • countryobject | nullrequired
    3 fields
    • noticesobject[]required
      6 fields
      • obligationstringrequired
      • event_datestringrequired
      • statusstringrequired
      • channelstring | nullrequired
      • referencestring | nullrequired
      • sent_onstring | nullrequired
    • country_dataobjectrequired
    • vacation_mapsobject[]
      4 fields
      • yearintegerrequired
      • versionintegerrequired
      • posted_onstringrequired
      • periodsobject[]required
        3 fields
        • startstringrequired
        • endstringrequired
        • daysnumberrequired
  • pay_report_inputsobject[]required
    6 fields
    • yearinteger | nullrequired
    • legal_entitystring | nullrequired
    • currencystring | nullrequired
    • bonusnumberrequired
    • allowancesnumberrequired
    • in_kindnumberrequired
  • bank_changesobject[]required
    7 fields
    • new_ibanstringrequired
    • statusstringrequired
    • requested_as"self" | "hr"required
    • created_atstringrequired
    • proofobject | nullrequired
      3 fields
      • content_typestringrequired
      • sizenumberrequired
      • uploaded_atstringrequired
    • verdictobject | nullrequired
      3 fields
      • resultstringrequired
      • reasonsstring[]required
      • checked_atstringrequired
    • decidedobject | nullrequired
      3 fields
      • how"automatic" | "hr"required
      • atstringrequired
      • notestring | nullrequired
  • pay_requestsobject[]required
    9 fields
    • idstringrequired
    • created_atstringrequired
    • due_onstringrequired
    • status"answered" | "open"required
    • answerobjectrequired
      6 fields
      • as_ofstringrequired
      • categoryobject | nullrequired

        Your category of workers: people doing the same work or work of equal value.

        2 fields
        • idstringrequired
        • namestringrequired
      • ownobject | nullrequired

        Your pay level that day: your gross pay in force, annualised (year: as is; month: × 12; hour: × your hours in a year), and per hour (your weekly hours, else FTE × the standard week). Null without pay recorded.

        3 fields
        • annualnumberrequired
        • hourlynumberrequired
        • currencystringrequired
      • womenobject | nullrequired

        Women in your category that day, not counting you, paid in your currency. Null when withheld.

        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • menobject | nullrequired
        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"required

        Why the averages were not given at once, so HR answers in writing within two months: small_group (fewer than the company's minimum of women or of men in your category, not counting you: averages could reveal a colleague's pay), recent_change (since your last answer, fewer than that minimum of people joined or left your category: comparing the two answers could reveal their pay), category_review (a job evaluation of your category is being changed, so HR confirms the category first), no_category (your job is in no pay category yet), no_pay (no pay recorded for you). Null: answered.

    • hr_replystring | nullrequired
    • answered_atstring | nullrequired
    • recorded_by_hrboolean
    • receivedstring | null
  • field_referencesobject[]required
    3 fields
    • fieldstringrequired
    • target"person" | "job" | "unit" | "position"required
    • recordstringrequired
  • documentsobject[]required
  • document_filesobject[]required
    2 fields
    • namestringrequired
    • urlstringrequired
  • payrollobject
  • equipmentobject[]required
    8 fields
    • typestringrequired
    • namestringrequired
    • modelstring | nullrequired
    • serialstring | nullrequired
    • fromstringrequired
    • tostring | nullrequired
    • confirmed_atstring | nullrequired
    • returnedobject | nullrequired
      2 fields
      • conditionstringrequired
      • notestring | nullrequired
  • time_offobject
  • time_clockobject
  • hiringobject
  • trainingobject
  • talentobject
  • compobject
  • insightsobject
  • shiftsobject
  • benefitsobject
  • surveysobject
  • assistantobject
  • filenamestringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/people.export_data \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"p1"}'
Response
{
  "data": {
    "format": "bizisy.person-data.v1",
    "generated_at": "2026-10-04T10:00:00.000Z",
    "organization_id": "o1",
    "filename": "ana-ferreira-data-2026-10-04.json",
    "person": {
      "id": "p1",
      "name": "Ana Ferreira"
    },
    "photo": {
      "content_type": "image/webp",
      "data_base64": "UklGRg==",
      "updated_at": "2026-10-04T10:00:00.000Z"
    },
    "jobs": [
      {
        "id": "j1",
        "valid_from": "2024-01-15",
        "valid_to": null,
        "title": "Engineer",
        "title_id": "t1",
        "display_title": null,
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "manager": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "location": {
          "id": "l1",
          "name": "Head office"
        },
        "legal_entity": {
          "id": "e1",
          "name": "Acme Lda"
        },
        "employment_type": "full_time",
        "fte": 1,
        "reason": "hire",
        "end_reason": null,
        "leaving_type": null,
        "told": null,
        "contract_type": "fixed_term",
        "contract_end_date": "2026-01-14",
        "probation_end_date": "2024-07-14",
        "weekly_hours": 40,
        "notice_period_days": 30,
        "custom": [
          {
            "key": "shift_pattern",
            "label": "Shift pattern",
            "type": "select",
            "tier": "job",
            "value": "Day"
          }
        ]
      }
    ],
    "pay": [
      {
        "id": "pay1",
        "valid_from": "2024-01-15",
        "valid_to": null,
        "amount": 42000,
        "currency": "EUR",
        "period": "year",
        "note": null,
        "created_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "pay_report_inputs": [
      {
        "year": 2025,
        "legal_entity": "Acme Lda",
        "currency": "EUR",
        "bonus": 1500,
        "allowances": 0,
        "in_kind": 0
      }
    ],
    "pay_requests": [
      {
        "id": "rq1",
        "created_at": "2026-10-04T10:00:00.000Z",
        "due_on": "2026-12-04",
        "status": "answered",
        "answer": {
          "as_of": "2026-10-04",
          "category": {
            "id": "c1",
            "name": "Engineering"
          },
          "own": {
            "annual": 45000,
            "hourly": 21.58,
            "currency": "EUR"
          },
          "women": {
            "count": 3,
            "annual_mean": 40000,
            "hourly_mean": 19.18
          },
          "men": {
            "count": 4,
            "annual_mean": 52000,
            "hourly_mean": 24.93
          },
          "withheld": null
        },
        "hr_reply": null,
        "answered_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "bank_changes": [
      {
        "new_iban": "PT50000201231234567890154",
        "status": "verified",
        "requested_as": "self",
        "created_at": "2026-10-04T10:00:00.000Z",
        "proof": {
          "content_type": "application/pdf",
          "size": 48211,
          "uploaded_at": "2026-10-04T10:01:00.000Z"
        },
        "verdict": {
          "result": "verified",
          "reasons": [
            "iban_on_document",
            "name_matches"
          ],
          "checked_at": "2026-10-04T10:01:02.000Z"
        },
        "decided": {
          "how": "hr",
          "at": "2026-10-04T11:00:00.000Z",
          "note": null
        }
      }
    ],
    "invites": [
      {
        "email": "ana@acme.test",
        "role": "member",
        "created_at": "2026-10-04T10:00:00.000Z",
        "expires_at": "2026-10-18T10:00:00.000Z",
        "accepted_at": null,
        "revoked_at": null
      }
    ],
    "logins": [
      {
        "email": "ana@acme.test",
        "roles": [
          "hr"
        ]
      }
    ],
    "api_keys": [],
    "connected_apps": [
      {
        "app": "Claude",
        "access": "me"
      }
    ],
    "activity": [
      {
        "at": "2026-10-04T10:00:00.000Z",
        "summary": "Updated your profile"
      }
    ],
    "activity_truncated": false,
    "change_history": [
      {
        "id": "01k0000000000000000000000c",
        "entry_id": "01k0000000000000000000000b",
        "at": "2026-10-04T10:00:00.000Z",
        "op": "update",
        "record": {
          "kind": "job",
          "id": "j1",
          "name": null,
          "date": "2026-11-01"
        },
        "person_ids": [
          "p1"
        ],
        "truncated": false,
        "fields": [
          {
            "key": "title",
            "label": null,
            "tier": "job",
            "before": {
              "t": "text",
              "v": "Engineer"
            },
            "after": {
              "t": "text",
              "v": "Senior Engineer"
            },
            "hidden": false
          },
          {
            "key": "manager_id",
            "label": null,
            "tier": "job",
            "before": {
              "t": "ref",
              "kind": "person",
              "id": "p2",
              "name": "Rui Costa"
            },
            "after": {
              "t": "ref",
              "kind": "person",
              "id": "p3",
              "name": null
            },
            "hidden": false
          },
          {
            "key": "iban",
            "label": null,
            "tier": "private",
            "before": null,
            "after": null,
            "hidden": true
          }
        ]
      }
    ],
    "change_history_truncated": false,
    "notifications": [
      {
        "type": "approval_request",
        "created_at": "2026-10-04T10:00:00.000Z",
        "read_at": null
      }
    ],
    "directory_accounts": [
      {
        "provider": "Google Workspace",
        "account": "ana@acme.test",
        "excluded": false
      },
      {
        "provider": "Okta",
        "account": "ana@acme.test",
        "excluded": false
      }
    ],
    "recruiting": [
      {
        "tool": "Teamtailor",
        "application_id": "81234",
        "received_at": "2025-12-01T09:00:00.000Z"
      }
    ],
    "spend_accounts": [
      {
        "tool": "Payhawk",
        "account": "ana@acme.test",
        "state": "active",
        "excluded": false
      }
    ],
    "announcements": [
      {
        "tool": "Slack",
        "kind": "joiner",
        "day": "2026-01-05",
        "status": "posted",
        "posted_at": "2026-01-05T09:02:00.000Z"
      }
    ],
    "home_preferences": [
      {
        "manage": null,
        "me": "me",
        "pins": {
          "manage": [],
          "me": [
            "page:/tasks"
          ]
        },
        "updated_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "reminders": [
      {
        "kind": "probation_end",
        "date": "2024-07-14",
        "sent_at": "2024-06-30T06:00:00.000Z"
      }
    ],
    "occupational_health_check": null,
    "check_ins": {
      "one_on_ones": [
        {
          "role": "person",
          "kind": "manager",
          "with": "Tomás Silva",
          "cadence": "weekly",
          "first_date": "2026-09-07",
          "last_held": "2026-09-28",
          "ended": false
        }
      ],
      "meetings": [
        {
          "role": "person",
          "date": "2026-09-28",
          "status": "held"
        }
      ],
      "points": [],
      "notes": [
        {
          "date": "2026-09-28",
          "text": "Ask about the course",
          "written_by": "them",
          "rating": "useful"
        }
      ],
      "quarterly": [],
      "exemptions": []
    },
    "company_announcements": {
      "received": [
        {
          "title": "New expense policy",
          "published_at": "2026-10-10T09:00:00.000Z",
          "requires_ack": true,
          "seen_at": "2026-10-10T09:30:00.000Z",
          "acknowledged_at": "2026-10-10T09:31:00.000Z",
          "via": "app",
          "fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
      ],
      "posted": []
    },
    "positions": [
      {
        "id": "pos1",
        "title": "Engineer",
        "status": "filled",
        "role": "filled"
      }
    ],
    "role_requests": [
      {
        "title": "Data Engineer",
        "kind": "backfill",
        "status": "waiting",
        "note": "Rui leaves at the end of November.",
        "asked_at": "2026-10-03T09:00:00.000Z"
      }
    ],
    "field_references": [
      {
        "field": "Buddy",
        "target": "person",
        "record": "Bea Silva"
      }
    ],
    "dotted_lines": [
      {
        "role": "person",
        "person": "Ana Ferreira",
        "manager": "João Pereira",
        "valid_from": "2026-01-05",
        "valid_to": null,
        "note": "Platform project"
      }
    ],
    "approvals": [
      {
        "kind": "job_change",
        "status": "approved",
        "effective_date": "2026-11-01",
        "proposed_at": "2026-10-04T10:00:00.000Z",
        "closed_at": "2026-10-05T09:00:00.000Z",
        "change": {
          "title": "Senior Engineer"
        },
        "steps": [
          {
            "role": "hr",
            "state": "approved",
            "decided_at": "2026-10-05T09:00:00.000Z",
            "comment": null,
            "automatic": false
          }
        ]
      }
    ],
    "saved_drafts": [],
    "groups": [
      {
        "name": "Engineering managers",
        "named_as": "manager"
      }
    ],
    "import_rows": [],
    "checklists": {
      "about_you": [
        {
          "name": "Onboarding",
          "kind": "onboarding",
          "status": "completed",
          "anchor_date": "2024-03-04",
          "started_at": "2024-02-20T10:00:00.000Z",
          "tasks": [
            {
              "title": "Get set up in Bizisy",
              "due_date": "2024-03-04",
              "status": "done",
              "skip_reason": null,
              "resolved_at": "2024-03-04T09:00:00.000Z",
              "comments": [
                {
                  "text": "Done on day one",
                  "at": "2024-03-04T09:00:00.000Z",
                  "by_you": true
                }
              ]
            }
          ]
        }
      ],
      "assigned_to_you": [
        {
          "checklist": "Onboarding",
          "title": "Plan the first week",
          "due_date": "2026-10-31",
          "status": "open",
          "resolved_at": null
        }
      ],
      "your_comments": [
        {
          "checklist": "Onboarding",
          "task": "Plan the first week",
          "text": "Agenda shared",
          "at": "2026-10-04T10:00:00.000Z"
        }
      ],
      "resolved_by_you": [
        {
          "checklist": "Onboarding",
          "task": "Plan the first week",
          "status": "done",
          "skip_reason": null,
          "resolved_at": "2026-10-04T10:00:00.000Z"
        }
      ],
      "template_tasks": [
        {
          "template": "IT onboarding",
          "task": "Laptop"
        }
      ]
    },
    "webhook_deliveries": [
      {
        "event_type": "person.hired",
        "endpoint_host": "hooks.example.com",
        "created_at": "2026-10-04T10:01:00.000Z",
        "status": "succeeded"
      }
    ],
    "integration_links": [],
    "country": {
      "notices": [
        {
          "obligation": "pt.hire",
          "event_date": "2026-10-20",
          "status": "sent",
          "channel": "webservice",
          "reference": null,
          "sent_on": "2026-10-12"
        }
      ],
      "country_data": {
        "nationality": "PT"
      }
    },
    "documents": [
      {
        "id": "d1",
        "title": "Contract 2026",
        "category": "Contract",
        "file": "documents/people/p1/d1-Contract 2026.pdf"
      }
    ],
    "document_files": [
      {
        "name": "documents/people/p1/d1-Contract 2026.pdf",
        "url": "https://storage.googleapis.com/b/orgs/o1/files/d1?X-Goog-Signature=x"
      }
    ],
    "equipment": [
      {
        "type": "laptop",
        "name": "MacBook Pro 14",
        "model": "MacBookPro18,3",
        "serial": "C02XY123",
        "from": "2026-01-05",
        "to": null,
        "confirmed_at": "2026-01-05T10:00:00.000Z",
        "returned": null
      }
    ]
  }
}

Headcount report#

POST/v1/org/reports.headcountRead

Monthly workforce numbers from the job history, from from_month to to_month (YYYY-MM, at most 36 months; default the last 12 months): headcount on the first and last day, FTE at month end, joiners (employment periods starting that month, rehires included), leavers (last day that month; leaver_types splits them: voluntary = resignation, retirement; involuntary = dismissal, redundancy, end of contract; other; not_recorded) and turnover_rate (leavers / average headcount; null when the average is under one person). The current month is counted as of today. breakdown counts people employed at the end of to_month (or today, if that is earlier), grouped by group_by: unit (default), location, legal_entity, employment_type or contract_type. totals sums the period. planned (when the report reaches today; else null): headcount employed today, open = positions with status open (not drafts or on-hold ones), planned = headcount + open; each breakdown row then also has open, the open positions in that group (null when grouped by employment_type, which positions do not have), and a group with only open positions gets a row with count 0. To list the people behind a number: each month's range (the days counted; the current month ends today) as org_people_list joined_between or left_between; a breakdown group as org_people_list with unit_id, location_id or legal_entity_id, as_of = as_of and status "active" (erased people are counted, anonymously, up to the day before their erase, but never listed). Owners, admins and HR. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).

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

Input

  • from_monthstring

    Pattern ^\d{4}-(0[1-9]|1[0-2])$.

  • to_monthstring

    Pattern ^\d{4}-(0[1-9]|1[0-2])$.

  • group_by"unit" | "location" | "legal_entity" | "employment_type" | "contract_type"

    Default "unit".

Returns

8 fields
  • from_monthstringrequired
  • to_monthstringrequired
  • group_by"unit" | "location" | "legal_entity" | "employment_type" | "contract_type"required
  • as_ofstringrequired
  • monthsobject[]required
    9 fields
    • monthstringrequired
    • headcount_startintegerrequired
    • headcount_endintegerrequired
    • fte_endnumberrequired
    • joinersintegerrequired
    • leaversintegerrequired
    • turnover_ratenumber | nullrequired
    • leaver_typesobjectrequired
      4 fields
      • voluntaryintegerrequired
      • involuntaryintegerrequired
      • otherintegerrequired
      • not_recordedintegerrequired
    • rangeobjectrequired
      2 fields
      • fromstringrequired
      • tostringrequired
  • breakdownobject[]required
    5 fields
    • keystring | nullrequired
    • labelstringrequired
    • countintegerrequired
    • ftenumberrequired
    • openinteger | nullrequired
  • plannedobject | nullrequired
    3 fields
    • headcountintegerrequired
    • openintegerrequired
    • plannedintegerrequired
  • totalsobjectrequired
    4 fields
    • joinersintegerrequired
    • leaversintegerrequired
    • turnover_ratenumber | nullrequired
    • leaver_typesobjectrequired
      4 fields
      • voluntaryintegerrequired
      • involuntaryintegerrequired
      • otherintegerrequired
      • not_recordedintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/reports.headcount \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from_month":"2025-11","to_month":"2026-10","group_by":"location"}'
Response
{
  "data": {
    "from_month": "2025-11",
    "to_month": "2026-10",
    "group_by": "location",
    "as_of": "2026-10-04",
    "months": [
      {
        "month": "2026-09",
        "headcount_start": 10,
        "headcount_end": 11,
        "fte_end": 10.5,
        "joiners": 1,
        "leavers": 0,
        "leaver_types": {
          "voluntary": 0,
          "involuntary": 0,
          "other": 0,
          "not_recorded": 0
        },
        "turnover_rate": 0,
        "range": {
          "from": "2026-09-01",
          "to": "2026-09-30"
        }
      },
      {
        "month": "2026-10",
        "headcount_start": 11,
        "headcount_end": 11,
        "fte_end": 10.5,
        "joiners": 0,
        "leavers": 0,
        "leaver_types": {
          "voluntary": 0,
          "involuntary": 0,
          "other": 0,
          "not_recorded": 0
        },
        "turnover_rate": null,
        "range": {
          "from": "2026-10-01",
          "to": "2026-10-04"
        }
      }
    ],
    "breakdown": [
      {
        "key": "u2",
        "label": "Engineering",
        "count": 6,
        "fte": 5.5,
        "open": 2
      },
      {
        "key": null,
        "label": "None",
        "count": 5,
        "fte": 5,
        "open": 0
      }
    ],
    "totals": {
      "joiners": 1,
      "leavers": 0,
      "turnover_rate": 0,
      "leaver_types": {
        "voluntary": 0,
        "involuntary": 0,
        "other": 0,
        "not_recorded": 0
      }
    },
    "planned": {
      "headcount": 11,
      "open": 2,
      "planned": 13
    }
  }
}

Span of control and layers#

POST/v1/org/reports.spansRead

Span of control and management layers from the reporting lines on as_of (default today). managers: everyone with at least one direct report, with direct and total reports, their layer (1 = the top) and flag: narrow (fewer than narrow_below direct reports, default 3) or wide (more than wide_above, default 15); thresholds after McKinsey's managerial archetypes (3–5 up to 15+ direct reports). summary: people, managers, individual contributors, layers (the deepest layer), average and median span, narrow and wide counts. units: per live team (with the people in it and every team below it), managers, average span and layers inside. Reporting lines are public (the org chart), so no job, private or pay details. Owners, admins and HR; never a custom role. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).

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

Input

  • as_ofstring
  • narrow_belowinteger

    From 1 to 50. Default 3.

  • wide_aboveinteger

    From 1 to 200. Default 15.

Returns

7 fields
  • as_ofstringrequired
  • narrow_belowintegerrequired
  • wide_aboveintegerrequired
  • summaryobjectrequired
    8 fields
    • peopleintegerrequired
    • managersintegerrequired
    • individual_contributorsintegerrequired
    • layersintegerrequired
    • average_spannumber | nullrequired
    • median_spannumber | nullrequired
    • narrowintegerrequired
    • wideintegerrequired
  • layersobject[]required
    3 fields
    • layerintegerrequired
    • peopleintegerrequired
    • managersintegerrequired
  • managersobject[]required
    7 fields
    • personobjectrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • titlestringrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • directintegerrequired
    • totalintegerrequired
    • layerintegerrequired
    • flag"narrow" | "wide"required
  • unitsobject[]required
    5 fields
    • unitobjectrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • peopleintegerrequired
    • managersintegerrequired
    • average_spannumber | nullrequired
    • layersintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/reports.spans \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"as_of":"2026-10-04","narrow_below":2,"wide_above":12}'
Response
{
  "data": {
    "as_of": "2026-10-04",
    "narrow_below": 2,
    "wide_above": 12,
    "summary": {
      "people": 11,
      "managers": 3,
      "individual_contributors": 8,
      "layers": 3,
      "average_span": 3.3,
      "median_span": 3,
      "narrow": 1,
      "wide": 0
    },
    "layers": [
      {
        "layer": 1,
        "people": 1,
        "managers": 1
      },
      {
        "layer": 2,
        "people": 3,
        "managers": 2
      },
      {
        "layer": 3,
        "people": 7,
        "managers": 0
      }
    ],
    "managers": [
      {
        "person": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "title": "CEO",
        "unit": {
          "id": "u1",
          "name": "Acme Lda"
        },
        "direct": 3,
        "total": 10,
        "layer": 1,
        "flag": null
      },
      {
        "person": {
          "id": "p7",
          "name": "João Pereira",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "title": "Engineering Manager",
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "direct": 2,
        "total": 2,
        "layer": 2,
        "flag": "narrow"
      }
    ],
    "units": [
      {
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "people": 6,
        "managers": 2,
        "average_span": 2.5,
        "layers": 2
      }
    ]
  }
}

HR overview#

POST/v1/org/reports.overviewRead

The indicators an HR lead follows, per month over `months` months up to to_month (default this month and 12; at most 36), for the whole company or one team (with the teams below it), location or legal entity. The current month counts as of today. Per month: headcount and FTE on the last day; joiners and leavers (employment periods starting, last days); turnover_rate (leavers ÷ the average of the first- and last-day headcount); average_tenure_years (from the start of each person's current continuous employment); average_span (direct reports of managers inside the population); absenteeism_rate (working days of health-related leave — sick and any type marked health — ÷ scheduled working days, from the time-off calendars; planned leave is not counted); pay_median, pay_mean (full-time annual base pay in the main currency) and pay_cost (actual monthly base). Totals: headcount with change since the first month; turnover over the whole period (leavers ÷ average headcount), with by_type (voluntary: resignation, retirement; involuntary: dismissal, redundancy, end of contract; other; not_recorded) and voluntary_rate and involuntary_rate; gender split, absenteeism and pay as of the period. Privacy: the gender split, absenteeism and pay are null with a *_hidden reason when fewer than 5 people are counted (small_group); pay and the gender split are never given to API keys, MCP or connected apps (apps: open Bizisy); absenteeism needs time off (time_off_off), and machines get it for the whole company only (apps when a filter is set). No per-person figures. Owners, admins and HR; never a custom role. To drill in: org_reports_headcount, org_reports_spans, timeoff_reports_absence. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).

Who can call it
Manage key owner admin hr
Keys and apps
Pay and the gender split are null (pay_hidden, gender_hidden: apps): they are shown only in Bizisy.
MCP tool
org_reports_overview on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • to_monthstring

    Pattern ^\d{4}-(0[1-9]|1[0-2])$.

  • monthsinteger

    From 1 to 36. Default 12.

  • unit_idstring | null
  • location_idstring | null
  • legal_entity_idstring | null

Returns

15 fields
  • from_monthstringrequired
  • to_monthstringrequired
  • as_ofstringrequired
  • filtersobjectrequired
    3 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • monthsobject[]required
    12 fields
    • monthstringrequired
    • headcountintegerrequired
    • ftenumberrequired
    • joinersintegerrequired
    • leaversintegerrequired
    • turnover_ratenumber | nullrequired
    • average_tenure_yearsnumber | nullrequired
    • average_spannumber | nullrequired
    • absenteeism_ratenumber | nullrequired

      null: time off off, under 5 people, or no scheduled days.

    • pay_mediannumber | nullrequired
    • pay_meannumber | nullrequired
    • pay_costnumber | nullrequired
  • headcountobjectrequired
    3 fields
    • valueintegerrequired
    • ftenumberrequired
    • changeintegerrequired

      Since the end of the first month.

  • turnoverobjectrequired
    6 fields
    • joinersintegerrequired
    • leaversintegerrequired
    • ratenumber | nullrequired
    • by_typeobjectrequired

      Leavers by why they left: voluntary (resignation, retirement), involuntary (dismissal, redundancy, end of contract), other (mutual agreement, death, other), not recorded.

      5 fields
      • voluntaryintegerrequired
      • involuntaryintegerrequired
      • otherintegerrequired
      • not_recordedintegerrequired
      • regrettedinteger

        Voluntary leavers HR marked as regretted (people analytics D4), when there are any: in the app only, never for API keys, MCP or connected apps.

    • voluntary_ratenumber | nullrequired
    • involuntary_ratenumber | nullrequired
  • tenureobjectrequired
    1 field
    • average_yearsnumber | nullrequired
  • spanobjectrequired
    2 fields
    • averagenumber | nullrequired
    • managersintegerrequired
  • genderobject | nullrequired
    3 fields
    • womenintegerrequired
    • menintegerrequired
    • otherintegerrequired
  • gender_hidden"small_group" | "apps" | "time_off_off" | "no_pay"required
  • absenteeismobject | nullrequired
    3 fields
    • ratenumber | nullrequired
    • health_daysnumberrequired
    • scheduled_daysnumberrequired
  • absenteeism_hidden"small_group" | "apps" | "time_off_off" | "no_pay"required
  • payobject | nullrequired
    7 fields
    • currencystringrequired
    • mediannumber | nullrequired
    • meannumber | nullrequired
    • costnumber | nullrequired
    • includedintegerrequired
    • not_includedintegerrequired
    • median_changenumber | nullrequired
  • pay_hidden"small_group" | "apps" | "time_off_off" | "no_pay"required

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/reports.overview \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to_month": "2026-10",
  "months": 24,
  "unit_id": "u2",
  "location_id": null,
  "legal_entity_id": null
}'
Response
{
  "data": {
    "from_month": "2026-09",
    "to_month": "2026-10",
    "as_of": "2026-10-04",
    "filters": {
      "unit": {
        "id": "u2",
        "name": "Engineering"
      },
      "location": null,
      "legal_entity": null
    },
    "months": [
      {
        "month": "2026-09",
        "headcount": 10,
        "fte": 9.5,
        "joiners": 1,
        "leavers": 0,
        "turnover_rate": 0,
        "average_tenure_years": 2.4,
        "average_span": 3.5,
        "absenteeism_rate": 0.031,
        "pay_median": 42000,
        "pay_mean": 44100,
        "pay_cost": 36750
      },
      {
        "month": "2026-10",
        "headcount": 11,
        "fte": 10.5,
        "joiners": 1,
        "leavers": 0,
        "turnover_rate": 0,
        "average_tenure_years": 2.3,
        "average_span": 3.7,
        "absenteeism_rate": null,
        "pay_median": 42500,
        "pay_mean": 44800,
        "pay_cost": 40100
      }
    ],
    "headcount": {
      "value": 11,
      "fte": 10.5,
      "change": 1
    },
    "turnover": {
      "joiners": 2,
      "leavers": 0,
      "rate": 0,
      "by_type": {
        "voluntary": 0,
        "involuntary": 0,
        "other": 0,
        "not_recorded": 0
      },
      "voluntary_rate": 0,
      "involuntary_rate": 0
    },
    "tenure": {
      "average_years": 2.3
    },
    "span": {
      "average": 3.7,
      "managers": 3
    },
    "gender": {
      "women": 5,
      "men": 6,
      "other": 0
    },
    "gender_hidden": null,
    "absenteeism": null,
    "absenteeism_hidden": "small_group",
    "pay": {
      "currency": "EUR",
      "median": 42500,
      "mean": 44800,
      "cost": 40100,
      "included": 11,
      "not_included": 0,
      "median_change": 0.0119
    },
    "pay_hidden": null
  }
}

Data quality#

POST/v1/org/data_quality.getRead

What is missing, contradicts itself or has gone stale in today's records, most severe first. Checks — missing: no_manager (everyone but the person at the top: the root team's lead, or the only one without a manager), no_team, no_location / no_legal_entity (when the company has any), no_contract_type; conflict: manager_left (their manager no longer works here), archived_team / archived_location / archived_entity, head_left (a team's lead no longer works here), contract_ended (a fixed-term contract's last day passed while they are still employed with no last day); stale: invited_waiting (invited by email over 30 days ago, still without details), position_overdue (an open position past its target start). Each issue may carry fix {action, input, field, to}: a suggested job change from today (the team lead as manager, the manager's team, the only location or entity, the manager's own manager, the nearest live team above) — run org_people_change_job with that input; approval rules apply. counts per check; at most 500 issues (total says how many). Owners, admins and HR; never a custom role.

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

Input

  • checkstring (enum)

    One of: no_manager, no_team, no_location, no_legal_entity, no_contract_type, manager_left, archived_team, archived_location, archived_entity, head_left, contract_ended, invited_waiting, position_overdue.

Returns

  • as_ofstringrequired
  • totalintegerrequired
  • countsobjectrequired
    5 fields
    • missingintegerrequired
    • conflictintegerrequired
    • staleintegerrequired
    • highintegerrequired
    • fixableintegerrequired
  • by_checkobject[]required
    2 fields
    • checkstring (enum)required

      One of: no_manager, no_team, no_location, no_legal_entity, no_contract_type, manager_left, archived_team, archived_location, archived_entity, head_left, contract_ended, invited_waiting, position_overdue.

    • countintegerrequired
  • issuesobject[]required
    10 fields
    • idstringrequired

      Stable per issue: <check>:<subject id>.

    • checkstring (enum)required

      One of: no_manager, no_team, no_location, no_legal_entity, no_contract_type, manager_left, archived_team, archived_location, archived_entity, head_left, contract_ended, invited_waiting, position_overdue.

    • category"missing" | "conflict" | "stale"required
    • severity"high" | "medium" | "low"required
    • personobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • positionobject | nullrequired
      2 fields
      • idstringrequired
      • titlestringrequired
    • relatedobject | nullrequired

      The manager who left, the archived team, location or entity, the lead who left.

      2 fields
      • idstringrequired
      • namestringrequired
    • datestring | nullrequired
    • fixobject | nullrequired

      A suggested fix: run action with input (from today; approval rules apply). null: fix it on the person, team or position page.

      4 fields
      • action"org.people.change_job"required
      • inputobjectrequired
      • field"manager" | "unit" | "location" | "legal_entity"required
      • toobjectrequired
        2 fields
        • idstringrequired
        • namestringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/data_quality.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"check":"no_manager"}'
Response
{
  "data": {
    "as_of": "2026-10-04",
    "total": 2,
    "counts": {
      "missing": 1,
      "conflict": 1,
      "stale": 0,
      "high": 2,
      "fixable": 1
    },
    "by_check": [
      {
        "check": "no_manager",
        "count": 1
      },
      {
        "check": "manager_left",
        "count": 1
      }
    ],
    "issues": [
      {
        "id": "manager_left:p3",
        "check": "manager_left",
        "category": "conflict",
        "severity": "high",
        "person": {
          "id": "p3",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "unit": null,
        "position": null,
        "related": {
          "id": "p9",
          "name": "Marta Lopes"
        },
        "date": "2026-09-30",
        "fix": {
          "action": "org.people.change_job",
          "input": {
            "person_id": "p3",
            "effective_date": "2026-10-04",
            "reason": "change",
            "manager_id": "p1"
          },
          "field": "manager",
          "to": {
            "id": "p1",
            "name": "Ana Ferreira"
          }
        }
      },
      {
        "id": "no_manager:p4",
        "check": "no_manager",
        "category": "missing",
        "severity": "high",
        "person": {
          "id": "p4",
          "name": "Lukas Weber",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "unit": null,
        "position": null,
        "related": null,
        "date": null,
        "fix": null
      }
    ]
  }
}

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

Developer docs