API reference
Start groups
Joiner waves: the people who start together, followed person by person — contract signed, admission notice, Bizisy invite, onboarding checklist and mandatory training.
5 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
Make a start group#
POST/v1/org/start_groups.createWrite
Groups people who start together to follow their first days on one page (contract signed, admission notice, Bizisy invite, onboarding checklist, mandatory training). start_date; person_ids (people starting or started in the last 30 days, at most 1000) — or leave it out to take everyone starting on start_date (hires from offers, imports or one by one). Nothing about the people changes. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_start_groups_createon HR Assistant- Preview
?dry_run=trueruns 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
namestring1–120 characters.
start_datestringrequiredperson_idsstring[]Up to 1000 items.
Returns
7 fields
idstringrequirednamestringrequiredstart_datestringrequiredpeopleintegerrequiredtotalsobjectrequired5 fields
contractobjectrequired2 fields
doneintegerrequiredofintegerrequired
noticeobjectrequired2 fields
doneintegerrequiredofintegerrequired
inviteobjectrequired2 fields
doneintegerrequiredofintegerrequired
onboardingobjectrequired2 fields
doneintegerrequiredofintegerrequired
trainingobjectrequired2 fields
doneintegerrequiredofintegerrequired
readyintegerrequiredcreated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/start_groups.create \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "December intake",
"start_date": "2026-12-01",
"person_ids": [
"p3",
"p4"
]
}'const res = await fetch('https://api.bizisy.com/v1/org/start_groups.create', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"name": "December intake",
"start_date": "2026-12-01",
"person_ids": [
"p3",
"p4"
]
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/start_groups.create",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "December intake",
"start_date": "2026-12-01",
"person_ids": [
"p3",
"p4",
],
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sg1",
"name": "December intake",
"start_date": "2026-12-01",
"people": 2,
"totals": {
"contract": {
"done": 1,
"of": 2
},
"notice": {
"done": 0,
"of": 2
},
"invite": {
"done": 1,
"of": 2
},
"onboarding": {
"done": 0,
"of": 2
},
"training": {
"done": 0,
"of": 0
}
},
"ready": 0,
"created_at": "2026-11-18T10:00:00.000Z"
}
}List start groups#
POST/v1/org/start_groups.listRead
Start groups, soonest start first (past ones within 60 days; at most 50), each with how many people and how many are ready per step. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_start_groups_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
itemsobject[]required7 fields
idstringrequirednamestringrequiredstart_datestringrequiredpeopleintegerrequiredtotalsobjectrequired5 fields
contractobjectrequired2 fields
doneintegerrequiredofintegerrequired
noticeobjectrequired2 fields
doneintegerrequiredofintegerrequired
inviteobjectrequired2 fields
doneintegerrequiredofintegerrequired
onboardingobjectrequired2 fields
doneintegerrequiredofintegerrequired
trainingobjectrequired2 fields
doneintegerrequiredofintegerrequired
readyintegerrequiredcreated_atstringrequired
startingobject[]requiredDays in the next 60 with people starting and no start group yet.
2 fields
datestringrequiredpeopleintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/start_groups.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/start_groups.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
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/start_groups.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "sg1",
"name": "December intake",
"start_date": "2026-12-01",
"people": 2,
"totals": {
"contract": {
"done": 1,
"of": 2
},
"notice": {
"done": 0,
"of": 2
},
"invite": {
"done": 1,
"of": 2
},
"onboarding": {
"done": 0,
"of": 2
},
"training": {
"done": 0,
"of": 0
}
},
"ready": 0,
"created_at": "2026-11-18T10:00:00.000Z"
}
],
"starting": [
{
"date": "2027-01-04",
"people": 12
}
]
}
}A start group, person by person#
POST/v1/org/start_groups.getRead
A start group with each person's steps: contract (none, todo: not sent; waiting: out for signature; done: signed; problem: not sent), notice (the admission notice to the authorities where the country asks for one: todo, done, problem), invite (todo: no invite; waiting: invited or scheduled; done: signed in), onboarding (the checklist: waiting with done/total, done), training (mandatory training due for them: waiting with done/total, done). none: the step doesn't apply (module off, no rule, no template). Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_start_groups_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
group_idstringrequired
Returns
groupobjectrequired7 fields
idstringrequirednamestringrequiredstart_datestringrequiredpeopleintegerrequiredtotalsobjectrequired5 fields
contractobjectrequired2 fields
doneintegerrequiredofintegerrequired
noticeobjectrequired2 fields
doneintegerrequiredofintegerrequired
inviteobjectrequired2 fields
doneintegerrequiredofintegerrequired
onboardingobjectrequired2 fields
doneintegerrequiredofintegerrequired
trainingobjectrequired2 fields
doneintegerrequiredofintegerrequired
readyintegerrequiredcreated_atstringrequired
peopleobject[]required5 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
teamobject | nullrequired2 fields
idstringrequirednamestringrequired
start_datestring | nullrequiredstepsobjectrequired5 fields
contractobjectrequired2 fields
state"none" | "todo" | "waiting" | "done" | "problem"requireddetailstring | nullrequired
noticeobjectrequired2 fields
state"none" | "todo" | "waiting" | "done" | "problem"requireddetailstring | nullrequired
inviteobjectrequired2 fields
state"none" | "todo" | "waiting" | "done" | "problem"requireddetailstring | nullrequired
onboardingobjectrequired2 fields
state"none" | "todo" | "waiting" | "done" | "problem"requireddetailstring | nullrequired
trainingobjectrequired2 fields
state"none" | "todo" | "waiting" | "done" | "problem"requireddetailstring | nullrequired
readybooleanrequiredEvery step that applies is done.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/start_groups.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"group_id":"sg1"}'const res = await fetch('https://api.bizisy.com/v1/org/start_groups.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"group_id": "sg1"
}),
});
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/start_groups.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"group_id": "sg1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"group": {
"id": "sg1",
"name": "December intake",
"start_date": "2026-12-01",
"people": 2,
"totals": {
"contract": {
"done": 1,
"of": 2
},
"notice": {
"done": 0,
"of": 2
},
"invite": {
"done": 1,
"of": 2
},
"onboarding": {
"done": 0,
"of": 2
},
"training": {
"done": 0,
"of": 0
}
},
"ready": 0,
"created_at": "2026-11-18T10:00:00.000Z"
},
"people": [
{
"person": {
"id": "p3",
"name": "Sofia Costa",
"title": "Agent",
"photo_url": null
},
"team": {
"id": "u2",
"name": "Sales"
},
"start_date": "2026-12-01",
"ready": false,
"steps": {
"contract": {
"state": "done",
"detail": "signed"
},
"notice": {
"state": "todo",
"detail": "due:2026-11-30"
},
"invite": {
"state": "waiting",
"detail": "scheduled:2026-12-01"
},
"onboarding": {
"state": "waiting",
"detail": "2/7"
},
"training": {
"state": "none",
"detail": null
}
}
}
]
}
}Change a start group#
POST/v1/org/start_groups.updateWrite
Renames a start group, or adds (add) or takes out (remove) people. Nothing about the people changes.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_start_groups_updateon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
group_idstringrequirednamestring1–120 characters.
addstring[]Up to 1000 items.
removestring[]Up to 1000 items.
Returns
7 fields
idstringrequirednamestringrequiredstart_datestringrequiredpeopleintegerrequiredtotalsobjectrequired5 fields
contractobjectrequired2 fields
doneintegerrequiredofintegerrequired
noticeobjectrequired2 fields
doneintegerrequiredofintegerrequired
inviteobjectrequired2 fields
doneintegerrequiredofintegerrequired
onboardingobjectrequired2 fields
doneintegerrequiredofintegerrequired
trainingobjectrequired2 fields
doneintegerrequiredofintegerrequired
readyintegerrequiredcreated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/start_groups.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"group_id":"sg1","name":"x","remove":["p3"]}'const res = await fetch('https://api.bizisy.com/v1/org/start_groups.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"group_id": "sg1",
"name": "x",
"remove": [
"p3"
]
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/start_groups.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"group_id": "sg1",
"name": "x",
"remove": [
"p3",
],
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "sg1",
"name": "x",
"start_date": "2026-12-01",
"people": 2,
"totals": {
"contract": {
"done": 1,
"of": 2
},
"notice": {
"done": 0,
"of": 2
},
"invite": {
"done": 1,
"of": 2
},
"onboarding": {
"done": 0,
"of": 2
},
"training": {
"done": 0,
"of": 0
}
},
"ready": 0,
"created_at": "2026-11-18T10:00:00.000Z"
}
}Delete a start group#
POST/v1/org/start_groups.deleteWrite
Deletes a start group (only the group: the people and everything about them stay).
- Who can call it
- Manage key owner admin hr
- MCP tool
org_start_groups_deleteon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
group_idstringrequired
Returns
deletedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/start_groups.delete \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"group_id":"sg1"}'const res = await fetch('https://api.bizisy.com/v1/org/start_groups.delete', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"group_id": "sg1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/start_groups.delete",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"group_id": "sg1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"deleted": true
}
}Something missing or wrong on this page? Write to hello@bizisy.com.