Skip to content

API reference

Google Calendar and Outlook Calendar

The first-day invites (and optional task due dates) Bizisy puts on the connected calendar for new hires: what is planned, what is on the calendar and when the rest goes out. The template is a connection setting; connecting happens in the web app.

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

Planned calendar invites for new hires#

POST/v1/org/calendar.agendaRead

What Bizisy puts on the connected calendar (Google Calendar or Outlook Calendar) for hires starting in the next 60 days: each first-day meeting of the company's template (Integrations → the calendar → Agenda) with its day, time, time zone and invited people, and, when task due dates are on, onboarding tasks as all-day events. state: on_calendar, next_sync or scheduled (sends_on: invites go out at most send_days_before days before the first day). person_id narrows to one hire. connected: whether the calendar is connected (planned events are listed either way, as the template would plan them). Invited people are names only, never email addresses. The template is changed with integrations_connections_update (settings: first_day, send_days_before, meetings, task_due; owners and admins, in Bizisy); Sync now is integrations_connections_run. Owners, admins and HR; never custom roles.

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

Input

  • connector"google_calendar" | "outlook_calendar"required
  • person_idstring

    1–64 characters.

Returns

  • connector"google_calendar" | "outlook_calendar"required
  • connectedbooleanrequired
  • statusstring | nullrequired
  • settingsobjectrequired

    The template in use: the connection's settings, or the defaults until connected.

    5 fields
    • first_daybooleanrequired
    • send_days_beforeintegerrequired

      From 1 to 60.

    • meetingsobject[]required

      Up to 6 items.

      10 fields
      • idstringrequired

        Pattern ^[a-z0-9]{1,12}$.

      • titlestringrequired

        1–80 characters.

      • dayintegerrequired

        From 0 to 20.

      • timestringrequired

        Pattern ^([01]\d|2[0-3]):[0-5]\d$.

      • minutesintegerrequired

        From 5 to 480.

      • new_hirebooleanrequired
      • managerbooleanrequired
      • teambooleanrequired
      • person_idsstring[]required

        1–64 characters. Up to 10 items.

      • notestring | nullrequired

        Up to 500 characters.

    • task_duebooleanrequired
    • interviewsbooleanrequired
  • eventsobject[]required
    12 fields
    • idstringrequired

      Stable id of the planned event (first:<person>:<meeting> or task:<checklist>:<task>).

    • kind"meeting" | "task" | "away"required

      meeting or task (this agenda lists only these); away: an out-of-office day from time off.

    • personobjectrequired

      The new hire.

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • titlestringrequired
    • daystringrequired

      YYYY-MM-DD, local to the hire's location.

    • all_daybooleanrequired
    • startstringrequired
    • endstringrequired

      Timed: ISO instants. All day: the day and the next (end exclusive).

    • time_zonestringrequired
    • attendeesobject[]required

      Invited people (the organizer, the connected account, is not listed).

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • state"on_calendar" | "next_sync" | "scheduled"required

      on_calendar: sent and up to date; next_sync: goes out or is updated at the next run (within the hour, or Sync now); scheduled: goes out on sends_on.

    • sends_onstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/calendar.agenda \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connector":"outlook_calendar","person_id":"p1"}'
Response
{
  "data": {
    "connector": "outlook_calendar",
    "connected": true,
    "status": "connected",
    "settings": {
      "first_day": true,
      "send_days_before": 14,
      "task_due": false,
      "interviews": true,
      "meetings": [
        {
          "id": "welcome",
          "title": "Welcome meeting",
          "day": 0,
          "time": "09:30",
          "minutes": 30,
          "new_hire": true,
          "manager": true,
          "team": false,
          "person_ids": [],
          "note": null
        }
      ]
    },
    "events": [
      {
        "id": "first:p1:welcome",
        "kind": "meeting",
        "person": {
          "id": "p1",
          "name": "Noa Silva",
          "title": "Engineer",
          "photo_url": null
        },
        "title": "Welcome meeting: Noa Silva",
        "day": "2026-10-12",
        "all_day": false,
        "start": "2026-10-12T08:30:00.000Z",
        "end": "2026-10-12T09:00:00.000Z",
        "time_zone": "Europe/Lisbon",
        "attendees": [
          {
            "id": "p1",
            "name": "Noa Silva",
            "title": "Engineer",
            "photo_url": null
          },
          {
            "id": "p2",
            "name": "Mia Rocha",
            "title": "Lead",
            "photo_url": null
          }
        ],
        "state": "on_calendar",
        "sends_on": "2026-09-28"
      },
      {
        "id": "task:r1:t5",
        "kind": "task",
        "person": {
          "id": "p1",
          "name": "Noa Silva",
          "title": "Engineer",
          "photo_url": null
        },
        "title": "Plan the first week: Noa Silva",
        "day": "2026-10-10",
        "all_day": true,
        "start": "2026-10-10",
        "end": "2026-10-11",
        "time_zone": "Europe/Lisbon",
        "attendees": [],
        "state": "scheduled",
        "sends_on": "2026-09-26"
      }
    ]
  }
}

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

Developer docs