API reference

Org chart

The org chart on any date, as nodes or as a list.

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

Org chart#

POST/v1/org/chart.getRead

Returns the org chart as of a date (as_of, default today) as a flat list of nodes {id, kind, parent_id, label, sublabel, person_id?, photo_url?} (photo_url: path of the person photo on the company address, null without one). by="manager" (default): one node per employed person under their manager. by="unit": unit nodes (sublabel = kind) with people under their unit. Person nodes also carry unit_id, location_id, status (active or pre_hire), start_date (of the current employment period), is_unit_head (the current team lead of a live unit: team leads have no history, so this is today's value whatever as_of), direct_count and total_count (direct and all reports by manager among the people in this chart); unit nodes carry direct_count and total_count (people directly in the unit, and in it and every unit below). leaving_on (last day, when a termination is scheduled), contract_end (contract end date) and next_change {on, reason, title} (the next scheduled job change in the current employment, e.g. a promotion; null when none) appear only on people whose job details you may see, as in org_people_get (yourself, your reports, or everyone for owners, admins and HR, also over MCP or an API key); for anyone else a future as_of still shows people employed today whose last day falls before it. include_upcoming=true adds people starting within upcoming_days (default 30, at most 365) after the date, with status pre_hire. include_positions=true adds open roles: nodes of kind "position" (label = the position title) for the open and on-hold positions you may see (owners, admins and HR: all; a manager: those in their line; anyone else: none), with position_status, target_start_date, reason, unit_id and location_id; by manager they hang under the person or position they report to; when that person is not on the chart (starting later, or left) under the first of their managers who is, and under a role you cannot see, its first visible ancestor (else at the top), by unit under their unit (or the company). They are never counted in direct_count or total_count, and with an as_of before today there are none (positions are today's plan).

Who can call it: Manage key any Manage role
Me key anyone
MCP tool: org_chart_get on My Workplace, HR Assistant
Method: POST with a JSON body, or GET with the input as query parameters

Input

as_ofstring
by"manager" | "unit"
Default "manager".
include_upcomingboolean
Default false.
upcoming_daysinteger
From 1 to 365.
include_positionsboolean
Default false.

Returns

nodesobject[]required
20 fields
- idstringrequired
- kind"person" | "unit" | "position"required
- parent_idstring | nullrequired
- labelstringrequired
- sublabelstring | nullrequired
- person_idstring
- photo_urlstring | null
- unit_idstring | null
- location_idstring | null
- status"active" | "pre_hire"
- start_datestring | null
- is_unit_headboolean
- direct_countinteger
- total_countinteger
- leaving_onstring | null
- contract_endstring | null
- next_changeobject | null
  3 fields
  - onstringrequired
  - reasonstringrequired
  - titlestringrequired
- position_status"open" | "on_hold"
- target_start_datestring | null
- reason"new" | "replacement"

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl

curl https://api.bizisy.com/v1/org/chart.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"include_upcoming":true,"upcoming_days":60}'

Node

const res = await fetch('https://api.bizisy.com/v1/org/chart.get', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "include_upcoming": true,
    "upcoming_days": 60
  }),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);

Python

import os
import requests

res = requests.post(
    "https://api.bizisy.com/v1/org/chart.get",
    headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
    json={
        "include_upcoming": True,
        "upcoming_days": 60,
    },
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Response

{
  "data": {
    "nodes": [
      {
        "id": "u1",
        "kind": "unit",
        "parent_id": null,
        "label": "Acme Lda",
        "sublabel": "company",
        "direct_count": 1,
        "total_count": 2
      },
      {
        "id": "p1",
        "kind": "person",
        "parent_id": "u1",
        "label": "Ana Ferreira",
        "sublabel": "Engineer",
        "person_id": "p1",
        "unit_id": "u1",
        "location_id": "l1",
        "status": "active",
        "start_date": "2024-01-15",
        "is_unit_head": true,
        "direct_count": 1,
        "total_count": 1,
        "leaving_on": null,
        "contract_end": "2027-01-14",
        "next_change": {
          "on": "2026-12-01",
          "reason": "promotion",
          "title": "Lead Engineer"
        }
      },
      {
        "id": "p3",
        "kind": "person",
        "parent_id": "p1",
        "label": "Rui Costa",
        "sublabel": "CTO",
        "person_id": "p3",
        "unit_id": null,
        "location_id": null,
        "status": "pre_hire",
        "start_date": "2026-11-02",
        "is_unit_head": false,
        "direct_count": 0,
        "total_count": 0
      },
      {
        "id": "pos1",
        "kind": "position",
        "parent_id": "p1",
        "label": "Data Engineer",
        "sublabel": null,
        "unit_id": "u1",
        "location_id": null,
        "position_status": "open",
        "target_start_date": "2026-12-01",
        "reason": "new"
      }
    ]
  }
}

Export the org chart as a list#

POST/v1/org/chart.exportRead

Returns the org chart as a list, one row per person, in reporting order (each manager followed by the people under them): name, title, team, manager (name and manager_id), location, status (active, or pre_hire for people starting soon), start_date, level (1 = the top of the company), direct_reports and total_reports. format "json" (default) returns rows; format "csv" returns a CSV file (UTF-8, comma-separated; delimiter ";" suits Excel in most of Europe; cells a spreadsheet would run as formulas are prefixed with '). Same people and dates as org_chart_get: as_of (default today), include_upcoming with upcoming_days (default 30, at most 365). Narrow it with root_person_id (that person and everyone under them; not_found if they are not on the chart on that date), unit_id (that team and its sub-teams; not_found for an unknown or archived team) and person_ids (only these people, at most 5000; ids not on the chart are ignored); filters combine. Everyone who can see the chart may use it, in the app, over MCP or with an API key. It never includes job details such as leaving dates, contract ends or scheduled changes, nor private or pay data. Pictures and PDFs of the chart are made in the Bizisy app (Org chart → Export).

Who can call it: Manage key any Manage role
Me key anyone
MCP tool: org_chart_export on My Workplace, HR Assistant
Method: POST with a JSON body, or GET with the input as query parameters