API reference
People flow
Who starts, leaves and moves on each day of a month (and the next two), in and out per team, with the month's batches and start groups.
1 action · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
People flow#
POST/v1/org/flow.monthRead
Who starts, leaves (on their last day) and moves team on each day of a month (month YYYY-MM, default this one) and the next months (months 1–3), filtered by unit_id, location_id or legal_entity_id; starts and moves in, leaves and moves out per team; and the move batches and start groups of the period with their progress. Days with nothing are left out. Job details: owners, admins and HR only, never a custom role; includes changes not announced to the people yet.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_flow_monthon HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
monthstringPattern
^\d{4}-\d{2}$.monthsintegerFrom 1 to 3. Default
1.unit_idstringlocation_idstringlegal_entity_idstring
Returns
7 fields
fromstringrequiredtostringrequiredtotalsobjectrequired3 fields
startsintegerrequiredleavesintegerrequiredmovesintegerrequired
daysobject[]requiredOnly days with something happening.
4 fields
datestringrequiredstartsobject[]required3 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
teamobject | nullrequired2 fields
idstringrequirednamestringrequired
from_teamobject | nullrequiredmoves: the team before.
2 fields
idstringrequirednamestringrequired
leavesobject[]required3 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
teamobject | nullrequired2 fields
idstringrequirednamestringrequired
from_teamobject | nullrequiredmoves: the team before.
2 fields
idstringrequirednamestringrequired
movesobject[]required3 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
teamobject | nullrequired2 fields
idstringrequirednamestringrequired
from_teamobject | nullrequiredmoves: the team before.
2 fields
idstringrequirednamestringrequired
teamsobject[]requiredStarts and moves in, leaves and moves out, per team (biggest change first, at most 30).
5 fields
idstring | nullrequirednamestringrequiredinintegerrequiredoutintegerrequirednetintegerrequired
wavesobject[]required7 fields
idstringrequirednamestringrequiredstatusstringrequireddatestringrequiredpeopleintegerrequireddoneintegerrequiredblockedintegerrequired
groupsobject[]required4 fields
idstringrequirednamestringrequireddatestringrequiredpeopleintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/flow.month \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"month": "2026-12",
"months": 3,
"unit_id": "u2",
"location_id": "l1",
"legal_entity_id": "e1"
}'const res = await fetch('https://api.bizisy.com/v1/org/flow.month', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"month": "2026-12",
"months": 3,
"unit_id": "u2",
"location_id": "l1",
"legal_entity_id": "e1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/flow.month",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"month": "2026-12",
"months": 3,
"unit_id": "u2",
"location_id": "l1",
"legal_entity_id": "e1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"from": "2026-12-01",
"to": "2026-12-31",
"totals": {
"starts": 1,
"leaves": 0,
"moves": 1
},
"days": [
{
"date": "2026-12-01",
"starts": [
{
"person": {
"id": "p3",
"name": "Sofia Costa",
"title": "Agent",
"photo_url": null
},
"team": {
"id": "u2",
"name": "Sales"
},
"from_team": null
}
],
"leaves": [],
"moves": [
{
"person": {
"id": "p4",
"name": "Rui Lopes",
"title": "Agent",
"photo_url": null
},
"team": {
"id": "u2",
"name": "Sales"
},
"from_team": {
"id": "u1",
"name": "Energy"
}
}
]
}
],
"teams": [
{
"id": "u2",
"name": "Sales",
"in": 2,
"out": 0,
"net": 2
},
{
"id": "u1",
"name": "Energy",
"in": 0,
"out": 1,
"net": -1
}
],
"waves": [
{
"id": "wv1",
"name": "Energy to Sales",
"status": "approved",
"date": "2026-12-01",
"people": 40,
"done": 0,
"blocked": 1
}
],
"groups": [
{
"id": "sg1",
"name": "December intake",
"date": "2026-12-01",
"people": 30
}
]
}
}Something missing or wrong on this page? Write to hello@bizisy.com.