Skip to content

API reference

Batches of job changes

Move waves: the same job change for many people from one date — prepare from a filter or a list, preview who is ready or blocked, one grouped approval, apply (big batches in the background), announced on their day.

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

Fill a batch of job changes from a sentence#

POST/v1/org/waves.describeWrite

Turns a sentence or a pasted list (text, at most 6000 characters) into the fields of a move batch for HR to check: who (teams, places, titles, managers' reports, or named people) and what changes (team, manager, place, title, weekly hours), the dates and a name. The language model sees the text and the company's team, place and title names, never people's names: Bizisy matches names to people itself and lists what it couldn't match (unmatched). Nothing is created: open the result in New batch (org_waves_create). It never chooses who moves. Uses AI credits by the tokens used; nothing when it fails. Owners, admins and HR, in the app.

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

  • textstringrequired

    3–6000 characters.

Returns

10 fields
  • namestring | nullrequired
  • effective_datestring | nullrequired
  • announce_onstring | nullrequired
  • filterobjectrequired
    4 fields
    • unit_idsstring[]required
    • location_idsstring[]required
    • title_idsstring[]required
    • manager_idsstring[]required
  • person_idsstring[]required
  • setobjectrequired
    5 fields
    • unit_idstring | nullrequired
    • manager_idstring | nullrequired
    • location_idstring | nullrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • unmatchedstring[]required

    Names in the text Bizisy could not match to exactly one team, place, title or person.

  • notesstring | nullrequired
  • ai_generatedtruerequired
  • ai_creditsobjectrequired
    2 fields
    • costintegerrequired
    • leftinteger | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.describe \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "text": "Move the 40 people of the energy campaign to Team Porto 3 from 1 December, Rui as manager"
}'
Response
{
  "data": {
    "name": "Energy campaign to Team Porto 3",
    "effective_date": "2026-12-01",
    "announce_on": null,
    "filter": {
      "unit_ids": [
        "u2"
      ],
      "location_ids": [],
      "title_ids": [],
      "manager_ids": []
    },
    "person_ids": [],
    "set": {
      "unit_id": "u3",
      "manager_id": "p2",
      "location_id": null,
      "title": null,
      "weekly_hours": null
    },
    "unmatched": [],
    "notes": null,
    "ai_generated": true,
    "ai_credits": {
      "cost": 2,
      "left": 498
    }
  }
}

Prepare a batch of job changes#

POST/v1/org/waves.createWrite

Prepares a move batch (a wave): the same job change for many people from effective_date — set any of unit_id (team), manager_id (null: no manager), location_id, title, weekly_hours. People: person_ids, or filter (unit_ids, location_ids, title_ids, manager_ids: people employed on the effective date matching all of them), at most 1000. announce_on (default today): the day people learn of their change; before it, their own pages, My workspace and exports show their job as it is. Nothing changes yet: the batch is checked person by person (ready with before and after, unchanged, or blocked and why — a change already waiting for approval, a reporting cycle, not employed that day…). Then org_waves_submit (when job changes need approval) or org_waves_apply. Owners, admins and HR.

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

  • namestringrequired

    1–120 characters.

  • effective_datestringrequired
  • announce_onstring
  • reason"change" | "transfer"
  • setobjectrequired
    5 fields
    • unit_idstring
    • manager_idstring | null
    • location_idstring
    • titlestring

      1–120 characters.

    • weekly_hoursnumber

      From 0 to 80.

  • person_idsstring[]

    Up to 1000 items.

  • filterobject
    4 fields
    • unit_idsstring[]

      Up to 200 items.

    • location_idsstring[]

      Up to 200 items.

    • title_idsstring[]

      Up to 200 items.

    • manager_idsstring[]

      Up to 200 items.

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.create \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Hours",
  "effective_date": "2027-01-04",
  "announce_on": "2026-12-01",
  "reason": "change",
  "set": {
    "weekly_hours": 35,
    "title": "Agent"
  },
  "person_ids": [
    "p3",
    "p4"
  ]
}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Hours",
    "kind": "move",
    "status": "draft",
    "effective_date": "2027-01-04",
    "announce_on": "2026-12-01",
    "reason": "change",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

List batches of job changes#

POST/v1/org/waves.listRead

Move batches (waves), newest first: name, status (draft, submitted for approval, approved, rejected, applying, done, stopped with people to fix, cancelled), effective and announce dates, what changes, counts per outcome and progress. Owners, admins and HR.

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

Input

  • status"open" | "all"

    Default "open".

Returns

  • itemsobject[]required
    15 fields
    • idstringrequired
    • namestringrequired
    • kind"move"required
    • statusstring (enum)required

      One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

    • effective_datestringrequired
    • announce_onstringrequired
    • reason"change" | "transfer"required
    • setobjectrequired
      5 fields
      • unitobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • managerobject | nullrequired
        2 fields
        • idstring | nullrequired
        • namestringrequired
      • locationobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • titlestring | nullrequired
      • weekly_hoursnumber | nullrequired
    • countsobjectrequired
      7 fields
      • readyintegerrequired
      • unchangedintegerrequired
      • blockedintegerrequired
      • excludedintegerrequired
      • requestedintegerrequired
      • appliedintegerrequired
      • failedintegerrequired
    • progressobjectrequired
      2 fields
      • doneintegerrequired
      • totalintegerrequired
    • approvalobjectrequired
      6 fields
      • neededbooleanrequired
      • outcome"approved" | "rejected"required
      • decided_byobject | nullrequired
        2 fields
        • namestringrequired
        • person_idstring | nullrequired
      • decided_atstring | nullrequired
      • commentstring | nullrequired
      • can_decidebooleanrequired
    • created_byobjectrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • errorstring | nullrequired
    • created_atstringrequired
    • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"all"}'
Response
{
  "data": {
    "items": [
      {
        "id": "wv1",
        "name": "Energy campaign to Team Porto 3",
        "kind": "move",
        "status": "draft",
        "effective_date": "2026-12-01",
        "announce_on": "2026-11-15",
        "reason": "transfer",
        "set": {
          "unit": {
            "id": "u3",
            "name": "Team Porto 3"
          },
          "manager": {
            "id": "p2",
            "name": "Rui Costa"
          },
          "location": null,
          "title": null,
          "weekly_hours": null
        },
        "counts": {
          "ready": 38,
          "unchanged": 1,
          "blocked": 1,
          "excluded": 0,
          "requested": 0,
          "applied": 0,
          "failed": 0
        },
        "progress": {
          "done": 0,
          "total": 0
        },
        "approval": {
          "needed": true,
          "outcome": null,
          "decided_by": null,
          "decided_at": null,
          "comment": null,
          "can_decide": false
        },
        "created_by": {
          "name": "Ana Ferreira",
          "person_id": "p1"
        },
        "error": null,
        "created_at": "2026-11-18T10:00:00.000Z",
        "updated_at": "2026-11-18T10:00:00.000Z"
      }
    ]
  }
}

Get a batch of job changes#

POST/v1/org/waves.getRead

One move batch with its counts, approval and progress; org_waves_rows lists its people.

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

Input

  • wave_idstringrequired

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wave_id":"wv1"}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Energy campaign to Team Porto 3",
    "kind": "move",
    "status": "draft",
    "effective_date": "2026-12-01",
    "announce_on": "2026-11-15",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

People in a batch of job changes#

POST/v1/org/waves.rowsRead

The people of a move batch with their outcome (ready, unchanged, blocked, excluded, applied, failed), why it is blocked or failed, and each field that changes (before → after, as display text). Filter by outcome; a page of up to 500 (offset).

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

Input

  • wave_idstringrequired
  • outcomestring (enum)

    One of: ready, unchanged, blocked, excluded, requested, applied, failed.

  • offsetinteger

    At least 0. Default 0.

  • limitinteger

    From 1 to 500. Default 200.

Returns

  • totalintegerrequired
  • itemsobject[]required
    4 fields
    • personobjectrequired
      3 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
    • outcomestring (enum)required

      One of: ready, unchanged, blocked, excluded, requested, applied, failed.

    • problemstring | nullrequired
    • changesobject[]required
      4 fields
      • fieldstringrequired
      • labelstringrequired
      • fromstring | nullrequired
      • tostring | nullrequired
  • next_offsetinteger | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.rows \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"wave_id":"wv1","outcome":"blocked","offset":0,"limit":50}'
Response
{
  "data": {
    "total": 1,
    "next_offset": null,
    "items": [
      {
        "person": {
          "id": "p3",
          "name": "Sofia Costa",
          "title": "Agent"
        },
        "outcome": "ready",
        "problem": null,
        "changes": [
          {
            "field": "unit",
            "label": "Team",
            "from": "Energy campaign",
            "to": "Team Porto 3"
          }
        ]
      }
    ]
  }
}

Change a batch before it applies#

POST/v1/org/waves.updateWrite

Changes a draft or rejected batch (a submitted one goes back to draft): name, effective_date, announce_on, set, exclude (person ids to leave out) or include (person ids to add back or add). Every person is checked again.

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

  • wave_idstringrequired
  • namestring

    1–120 characters.

  • effective_datestring
  • announce_onstring
  • setobject
    5 fields
    • unit_idstring
    • manager_idstring | null
    • location_idstring
    • titlestring

      1–120 characters.

    • weekly_hoursnumber

      From 0 to 80.

  • excludestring[]

    Up to 1000 items.

  • includestring[]

    Up to 1000 items.

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "wave_id": "wv1",
  "name": "x",
  "effective_date": "2026-12-02",
  "announce_on": "2026-11-16",
  "set": {
    "unit_id": "u3"
  },
  "include": [
    "p5"
  ]
}'
Response
{
  "data": {
    "id": "wv1",
    "name": "x",
    "kind": "move",
    "status": "draft",
    "effective_date": "2026-12-02",
    "announce_on": "2026-11-16",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

Send a batch for approval#

POST/v1/org/waves.submitWrite

Sends a checked draft batch for one grouped approval: another owner, admin or HR member approves or rejects the whole batch in Bizisy (org_waves_decide), leaving out anyone they choose. Needed when Settings → Approval rules asks for approval of job changes; without that rule it is optional (a second pair of eyes), and the batch can be applied directly.

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

  • wave_idstringrequired

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.submit \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"wave_id":"wv1"}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Energy campaign to Team Porto 3",
    "kind": "move",
    "status": "submitted",
    "effective_date": "2026-12-01",
    "announce_on": "2026-11-15",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

Approve or reject a batch#

POST/v1/org/waves.decideWrite

Approves (approve: true) or rejects a batch sent for approval, in one decision; exclude leaves named people out of an approval (the rest move). Another owner, admin or HR member than the one who prepared it (unless they are the only one), in Bizisy only. Approving does not apply it yet: org_waves_apply does.

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

  • wave_idstringrequired
  • approvebooleanrequired
  • excludestring[]

    Up to 1000 items.

  • commentstring

    Up to 500 characters.

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.decide \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "wave_id": "wv1",
  "approve": false,
  "exclude": [
    "p3"
  ],
  "comment": "Not before January"
}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Energy campaign to Team Porto 3",
    "kind": "move",
    "status": "approved",
    "effective_date": "2026-12-01",
    "announce_on": "2026-11-15",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": "approved",
      "decided_by": {
        "name": "Hal Reis",
        "person_id": "p5"
      },
      "decided_at": "2026-11-18T11:00:00.000Z",
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

Apply a batch of job changes#

POST/v1/org/waves.applyWrite

Applies a batch: every ready person gets the job change from the effective date, through the same rules as org_people_change_job (checked again now; those who no longer pass are parked with why, the rest go on). Needs the batch approved when job changes need approval. Up to 50 people at once (status done, or stopped when someone was parked); more in the background in batches of 25 (status applying, progress): follow with org_waves_get; apply again to resume after fixing what was parked. Owners, admins and HR, in Bizisy for big batches.

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

  • wave_idstringrequired

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.apply \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"wave_id":"wv1"}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Energy campaign to Team Porto 3",
    "kind": "move",
    "status": "done",
    "effective_date": "2026-12-01",
    "announce_on": "2026-11-15",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 0,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 38,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

Cancel or stop a batch#

POST/v1/org/waves.cancelWrite

Cancels a batch that has not applied anyone, or stops one that is applying (people already moved keep their change; change them back with org_people_change_job).

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

  • wave_idstringrequired

Returns

15 fields
  • idstringrequired
  • namestringrequired
  • kind"move"required
  • statusstring (enum)required

    One of: draft, submitted, approved, rejected, applying, done, stopped, cancelled.

  • effective_datestringrequired
  • announce_onstringrequired
  • reason"change" | "transfer"required
  • setobjectrequired
    5 fields
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      2 fields
      • idstring | nullrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • titlestring | nullrequired
    • weekly_hoursnumber | nullrequired
  • countsobjectrequired
    7 fields
    • readyintegerrequired
    • unchangedintegerrequired
    • blockedintegerrequired
    • excludedintegerrequired
    • requestedintegerrequired
    • appliedintegerrequired
    • failedintegerrequired
  • progressobjectrequired
    2 fields
    • doneintegerrequired
    • totalintegerrequired
  • approvalobjectrequired
    6 fields
    • neededbooleanrequired
    • outcome"approved" | "rejected"required
    • decided_byobject | nullrequired
      2 fields
      • namestringrequired
      • person_idstring | nullrequired
    • decided_atstring | nullrequired
    • commentstring | nullrequired
    • can_decidebooleanrequired
  • created_byobjectrequired
    2 fields
    • namestringrequired
    • person_idstring | nullrequired
  • errorstring | nullrequired
  • created_atstringrequired
  • updated_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/waves.cancel \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"wave_id":"wv1"}'
Response
{
  "data": {
    "id": "wv1",
    "name": "Energy campaign to Team Porto 3",
    "kind": "move",
    "status": "cancelled",
    "effective_date": "2026-12-01",
    "announce_on": "2026-11-15",
    "reason": "transfer",
    "set": {
      "unit": {
        "id": "u3",
        "name": "Team Porto 3"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa"
      },
      "location": null,
      "title": null,
      "weekly_hours": null
    },
    "counts": {
      "ready": 38,
      "unchanged": 1,
      "blocked": 1,
      "excluded": 0,
      "requested": 0,
      "applied": 0,
      "failed": 0
    },
    "progress": {
      "done": 0,
      "total": 0
    },
    "approval": {
      "needed": true,
      "outcome": null,
      "decided_by": null,
      "decided_at": null,
      "comment": null,
      "can_decide": false
    },
    "created_by": {
      "name": "Ana Ferreira",
      "person_id": "p1"
    },
    "error": null,
    "created_at": "2026-11-18T10:00:00.000Z",
    "updated_at": "2026-11-18T10:00:00.000Z"
  }
}

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

Developer docs