Skip to content

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_create 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

  • namestring

    1–120 characters.

  • start_datestringrequired
  • person_idsstring[]

    Up to 1000 items.

Returns

7 fields
  • idstringrequired
  • namestringrequired
  • start_datestringrequired
  • peopleintegerrequired
  • totalsobjectrequired
    5 fields
    • contractobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • noticeobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • inviteobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • onboardingobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • trainingobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
  • readyintegerrequired
  • created_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
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"
  ]
}'
Response
{
  "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_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • itemsobject[]required
    7 fields
    • idstringrequired
    • namestringrequired
    • start_datestringrequired
    • peopleintegerrequired
    • totalsobjectrequired
      5 fields
      • contractobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • noticeobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • inviteobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • onboardingobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • trainingobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
    • readyintegerrequired
    • created_atstringrequired
  • startingobject[]required

    Days in the next 60 with people starting and no start group yet.

    2 fields
    • datestringrequired
    • peopleintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/start_groups.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "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_get on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • group_idstringrequired

Returns

  • groupobjectrequired
    7 fields
    • idstringrequired
    • namestringrequired
    • start_datestringrequired
    • peopleintegerrequired
    • totalsobjectrequired
      5 fields
      • contractobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • noticeobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • inviteobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • onboardingobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
      • trainingobjectrequired
        2 fields
        • doneintegerrequired
        • ofintegerrequired
    • readyintegerrequired
    • created_atstringrequired
  • peopleobject[]required
    5 fields
    • personobjectrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • teamobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • start_datestring | nullrequired
    • stepsobjectrequired
      5 fields
      • contractobjectrequired
        2 fields
        • state"none" | "todo" | "waiting" | "done" | "problem"required
        • detailstring | nullrequired
      • noticeobjectrequired
        2 fields
        • state"none" | "todo" | "waiting" | "done" | "problem"required
        • detailstring | nullrequired
      • inviteobjectrequired
        2 fields
        • state"none" | "todo" | "waiting" | "done" | "problem"required
        • detailstring | nullrequired
      • onboardingobjectrequired
        2 fields
        • state"none" | "todo" | "waiting" | "done" | "problem"required
        • detailstring | nullrequired
      • trainingobjectrequired
        2 fields
        • state"none" | "todo" | "waiting" | "done" | "problem"required
        • detailstring | nullrequired
    • readybooleanrequired

      Every step that applies is done.

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
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"}'
Response
{
  "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_update on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • group_idstringrequired
  • namestring

    1–120 characters.

  • addstring[]

    Up to 1000 items.

  • removestring[]

    Up to 1000 items.

Returns

7 fields
  • idstringrequired
  • namestringrequired
  • start_datestringrequired
  • peopleintegerrequired
  • totalsobjectrequired
    5 fields
    • contractobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • noticeobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • inviteobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • onboardingobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
    • trainingobjectrequired
      2 fields
      • doneintegerrequired
      • ofintegerrequired
  • readyintegerrequired
  • created_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
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"]}'
Response
{
  "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_delete on HR Assistant
Preview
?dry_run=true runs 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
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"}'
Response
{
  "data": {
    "deleted": true
  }
}

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

Developer docs