Skip to content

API reference

Self-service

A person's own profile, team, photo, data export, how pay is set and requests about pay levels, and people joining your team (Me keys).

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

My profile#

POST/v1/org/me.getRead

Returns your own person record: profile (including private fields), current job, manager, reports and job history. role: your job title and its role profile (what the role does), when HR wrote one in the job title catalog. coming: what is coming up for you in the next 60 days, soonest first — your first day (if you start later), probation end, contract end, job changes already recorded with a future date (reason and new title) and your work anniversary (years in your current employment). Change requests still waiting for approval are never listed, nor is a last day HR has planned for you: your record shows the end of your employment once that day has passed. Start here for anything about "me".

Who can call it
Me key anyone
MCP tool
org_me_get on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

37 fields
  • idstringrequired
  • namestringrequired
  • given_namestringrequired
  • family_namestringrequired
  • preferred_namestring | nullrequired
  • work_emailstringrequired
  • titlestring | nullrequired
  • status"invited" | "pre_hire" | "active" | "terminated" | "none"required

    invited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.

  • start_datestring | nullrequired
  • unitobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • locationobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • managerobject | nullrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • invitedbooleanrequired
  • has_loginbooleanrequired
  • photo_urlstring | nullrequired
  • pronounsstring | nullrequired
  • work_phonestring | nullrequired
  • personal_emailstring | nullrequired
  • personal_phonestring | nullrequired
  • addressobject | nullrequired
    5 fields
    • line1stringrequired
    • line2string
    • citystringrequired
    • postal_codestring
    • countrystringrequired
  • birthdaystring | nullrequired
  • sex"female" | "male" | "another" | "undisclosed"required

    For equal-pay reporting only (private: the person, owners, admins and HR in the app). female and male are compared; another and undisclosed are counted, not compared.

  • emergency_contactsobject[] | nullrequired
    3 fields
    • namestringrequired
    • relationshipstringrequired
    • phonestringrequired
  • tax_idstring | nullrequired
  • social_security_numberstring | nullrequired
  • ibanstring | nullrequired
  • customobject[]required
    7 fields
    • keystringrequired
    • labelstringrequired
    • typestring (enum)required

      One of: text, number, date, select, boolean, file, person, table.

    • tier"public" | "job" | "private"required
    • valuestring | number | boolean | object[]required

      For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

    • fileobject | null

      Type file only: the file, or null when none is attached.

      4 fields
      • namestring | nullrequired

        The file name; null over an API key or MCP for someone else's file.

      • sizeintegerrequired
      • content_typestringrequired
      • previewablebooleanrequired

        The web app can show it (PDF, PNG, JPEG, WebP).

    • personobject | null

      Type person only: who it names (null when not set, or not someone you may see).

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
  • jobobject | nullrequired
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • historyobject[] | nullrequired
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • reportsobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • visible_tiers"public" | "private" | "job" | "pay"[]required
  • plannedobject | nullrequired

    While invited (status invited): the job details known so far (job tier; null otherwise or when not visible).

    14 fields
    • titlestring | nullrequired
    • title_idstring | nullrequired
    • start_datestring | nullrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumber | nullrequired
    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
  • missing"given_name" | "family_name" | "title" | "start_date"[]required

    While invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.

  • dotted_managersobject[]required

    Dotted-line managers today (spec structure-over-time D10): they see job details, never approve.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • dotted_reportsobject[]required

    People this person has a dotted line to today.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • comingobject[]required
    5 fields
    • kind"starts" | "probation_ends" | "contract_ends" | "job_change" | "last_day" | "anniversary"required
    • datestringrequired
    • reasonstring | nullrequired
    • titlestring | nullrequired
    • yearsinteger | nullrequired
  • roleobject | nullrequired
    2 fields
    • titlestringrequired
    • descriptionstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.get \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "id": "p1",
    "name": "Ana Ferreira",
    "given_name": "Ana",
    "family_name": "Ferreira",
    "preferred_name": null,
    "work_email": "ana@acme.test",
    "title": "Engineer",
    "status": "active",
    "start_date": "2024-01-15",
    "unit": {
      "id": "u2",
      "name": "Engineering"
    },
    "location": {
      "id": "l1",
      "name": "Head office"
    },
    "manager": {
      "id": "p2",
      "name": "Rui Costa",
      "title": "CTO",
      "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
    },
    "invited": true,
    "has_login": true,
    "photo_url": null,
    "pronouns": "she/her",
    "work_phone": "+351 210 000 000",
    "personal_email": null,
    "personal_phone": null,
    "address": {
      "line1": "Rua Augusta 100",
      "city": "Lisboa",
      "country": "PT"
    },
    "birthday": "1990-04-10",
    "sex": "female",
    "emergency_contacts": [
      {
        "name": "Rui",
        "relationship": "Partner",
        "phone": "+351 911 000 000"
      }
    ],
    "tax_id": "123456789",
    "social_security_number": null,
    "iban": "PT50000201231234567890154",
    "custom": [
      {
        "key": "t_shirt_size",
        "label": "T-shirt size",
        "type": "select",
        "tier": "public",
        "value": "M"
      },
      {
        "key": "remote",
        "label": "Remote allowance",
        "type": "boolean",
        "tier": "job",
        "value": null
      },
      {
        "key": "driving_licence",
        "label": "Driving licence",
        "type": "file",
        "tier": "private",
        "value": "d5",
        "file": {
          "name": "Licence.pdf",
          "size": 182000,
          "content_type": "application/pdf",
          "previewable": true
        }
      }
    ],
    "job": {
      "id": "j1",
      "valid_from": "2024-01-15",
      "valid_to": null,
      "title": "Engineer",
      "title_id": "t1",
      "display_title": null,
      "unit": {
        "id": "u2",
        "name": "Engineering"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      },
      "location": {
        "id": "l1",
        "name": "Head office"
      },
      "legal_entity": {
        "id": "e1",
        "name": "Acme Lda"
      },
      "employment_type": "full_time",
      "fte": 1,
      "reason": "hire",
      "end_reason": null,
      "leaving_type": null,
      "told": null,
      "contract_type": "fixed_term",
      "contract_end_date": "2026-01-14",
      "probation_end_date": "2024-07-14",
      "weekly_hours": 40,
      "notice_period_days": 30,
      "custom": [
        {
          "key": "shift_pattern",
          "label": "Shift pattern",
          "type": "select",
          "tier": "job",
          "value": "Day"
        }
      ]
    },
    "history": null,
    "reports": [],
    "visible_tiers": [
      "public",
      "private",
      "job",
      "pay"
    ],
    "planned": null,
    "missing": [],
    "dotted_managers": [
      {
        "id": "p7",
        "name": "João Pereira",
        "title": "Sales Lead",
        "photo_url": null
      }
    ],
    "dotted_reports": [],
    "role": {
      "title": "Engineer",
      "description": "Designs, builds and runs the product with the team."
    },
    "coming": [
      {
        "kind": "probation_ends",
        "date": "2026-10-30",
        "reason": null,
        "title": null,
        "years": null
      },
      {
        "kind": "job_change",
        "date": "2026-11-01",
        "reason": "promotion",
        "title": "Senior Engineer",
        "years": null
      },
      {
        "kind": "anniversary",
        "date": "2026-11-20",
        "reason": null,
        "title": null,
        "years": 3
      }
    ]
  }
}

Update my profile#

POST/v1/org/me.updateWrite

Updates your own self-editable fields: preferred_name, pronouns, work_phone, personal_email, personal_phone, address ({line1, line2?, city, postal_code?, country}), birthday (YYYY-MM-DD), sex (female, male, another or undisclosed: optional, for equal-pay reporting only; only owners, admins and HR see it, and only in totals) and emergency_contacts (up to 5 of {name, relationship, phone}; the list replaces the old one), or emergency_contacts_add / emergency_contacts_remove (by name) to change some, and address_merge to change some address fields. Payroll details (tax_id, social_security_number, iban) can only be changed by signing in to Bizisy, never over MCP or an API key. Send only what changes; null clears. Names, work email and job fields are changed by HR. Use dry_run first and confirm with the user.

Who can call it
Me key anyone
Keys and apps
Payroll details (tax_id, social_security_number, iban) are refused.
MCP tool
org_me_update on My Workplace
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

  • preferred_namestring | null

    1–100 characters.

  • pronounsstring | null

    Up to 40 characters.

  • work_phonestring | null

    Pattern ^\+?[0-9 ().-]{3,40}$.

  • personal_emailany | null
  • personal_phonestring | null

    Pattern ^\+?[0-9 ().-]{3,40}$.

  • addressobject | null
    5 fields
    • line1stringrequired

      1–200 characters.

    • line2string

      Up to 200 characters.

    • citystringrequired

      1–100 characters.

    • postal_codestring

      Up to 20 characters.

    • countryanyrequired
  • birthdaystring | null
  • sex"female" | "male" | "another" | "undisclosed"

    Sex for equal-pay reporting (EU Pay Transparency Directive): female, male, another or undisclosed. Private; used in pay gap totals only.

  • emergency_contactsobject[]

    Up to 5 items.

    3 fields
    • namestringrequired

      1–100 characters.

    • relationshipstringrequired

      1–60 characters.

    • phonestringrequired

      Pattern ^\+?[0-9 ().-]{3,40}$.

  • tax_idstring | null

    Pattern ^[A-Za-z0-9 ./-]{1,40}$.

  • social_security_numberstring | null

    Pattern ^[A-Za-z0-9 ./-]{1,40}$.

  • ibanany | null
  • emergency_contacts_addobject[]

    Contacts to add to the current list (at most 5 in all).

    1–5 items.

    3 fields
    • namestringrequired

      1–100 characters.

    • relationshipstringrequired

      1–60 characters.

    • phonestringrequired

      Pattern ^\+?[0-9 ().-]{3,40}$.

  • emergency_contacts_removestring[]

    Names of contacts to remove (case-insensitive; each must be in the list).

    1–100 characters. 1–5 items.

  • address_mergeobject

    Address fields to change, kept over the current address (null clears line2 or postal_code). Without a current address, line1, city and country are needed.

    5 fields
    • line1string

      1–200 characters.

    • line2string | null

      Up to 200 characters.

    • citystring

      1–100 characters.

    • postal_codestring | null

      Up to 20 characters.

    • countryany

Returns

35 fields
  • idstringrequired
  • namestringrequired
  • given_namestringrequired
  • family_namestringrequired
  • preferred_namestring | nullrequired
  • work_emailstringrequired
  • titlestring | nullrequired
  • status"invited" | "pre_hire" | "active" | "terminated" | "none"required

    invited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.

  • start_datestring | nullrequired
  • unitobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • locationobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • managerobject | nullrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • invitedbooleanrequired
  • has_loginbooleanrequired
  • photo_urlstring | nullrequired
  • pronounsstring | nullrequired
  • work_phonestring | nullrequired
  • personal_emailstring | nullrequired
  • personal_phonestring | nullrequired
  • addressobject | nullrequired
    5 fields
    • line1stringrequired
    • line2string
    • citystringrequired
    • postal_codestring
    • countrystringrequired
  • birthdaystring | nullrequired
  • sex"female" | "male" | "another" | "undisclosed"required

    For equal-pay reporting only (private: the person, owners, admins and HR in the app). female and male are compared; another and undisclosed are counted, not compared.

  • emergency_contactsobject[] | nullrequired
    3 fields
    • namestringrequired
    • relationshipstringrequired
    • phonestringrequired
  • tax_idstring | nullrequired
  • social_security_numberstring | nullrequired
  • ibanstring | nullrequired
  • customobject[]required
    7 fields
    • keystringrequired
    • labelstringrequired
    • typestring (enum)required

      One of: text, number, date, select, boolean, file, person, table.

    • tier"public" | "job" | "private"required
    • valuestring | number | boolean | object[]required

      For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

    • fileobject | null

      Type file only: the file, or null when none is attached.

      4 fields
      • namestring | nullrequired

        The file name; null over an API key or MCP for someone else's file.

      • sizeintegerrequired
      • content_typestringrequired
      • previewablebooleanrequired

        The web app can show it (PDF, PNG, JPEG, WebP).

    • personobject | null

      Type person only: who it names (null when not set, or not someone you may see).

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
  • jobobject | nullrequired
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • historyobject[] | nullrequired
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • reportsobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • visible_tiers"public" | "private" | "job" | "pay"[]required
  • plannedobject | nullrequired

    While invited (status invited): the job details known so far (job tier; null otherwise or when not visible).

    14 fields
    • titlestring | nullrequired
    • title_idstring | nullrequired
    • start_datestring | nullrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumber | nullrequired
    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
  • missing"given_name" | "family_name" | "title" | "start_date"[]required

    While invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.

  • dotted_managersobject[]required

    Dotted-line managers today (spec structure-over-time D10): they see job details, never approve.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • dotted_reportsobject[]required

    People this person has a dotted line to today.

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

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.update \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "preferred_name": null,
  "pronouns": "she/her",
  "work_phone": "+351 912",
  "personal_email": null,
  "personal_phone": null,
  "birthday": null,
  "sex": "undisclosed",
  "address": {
    "line1": "Rua Augusta 100",
    "city": "Lisboa",
    "country": "PT"
  },
  "emergency_contacts": [
    {
      "name": "Rui",
      "relationship": "Partner",
      "phone": "+351 911"
    }
  ]
}'
Response
{
  "data": {
    "id": "p1",
    "name": "Ana Ferreira",
    "given_name": "Ana",
    "family_name": "Ferreira",
    "preferred_name": null,
    "work_email": "ana@acme.test",
    "title": "Engineer",
    "status": "active",
    "start_date": "2024-01-15",
    "unit": {
      "id": "u2",
      "name": "Engineering"
    },
    "location": {
      "id": "l1",
      "name": "Head office"
    },
    "manager": {
      "id": "p2",
      "name": "Rui Costa",
      "title": "CTO",
      "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
    },
    "invited": true,
    "has_login": true,
    "photo_url": null,
    "pronouns": "she/her",
    "work_phone": "+351 912",
    "personal_email": null,
    "personal_phone": null,
    "address": {
      "line1": "Rua Augusta 100",
      "city": "Lisboa",
      "country": "PT"
    },
    "birthday": "1990-04-10",
    "sex": "undisclosed",
    "emergency_contacts": [
      {
        "name": "Rui",
        "relationship": "Partner",
        "phone": "+351 911 000 000"
      }
    ],
    "tax_id": "123456789",
    "social_security_number": null,
    "iban": "PT50000201231234567890154",
    "custom": [
      {
        "key": "t_shirt_size",
        "label": "T-shirt size",
        "type": "select",
        "tier": "public",
        "value": "M"
      },
      {
        "key": "remote",
        "label": "Remote allowance",
        "type": "boolean",
        "tier": "job",
        "value": null
      },
      {
        "key": "driving_licence",
        "label": "Driving licence",
        "type": "file",
        "tier": "private",
        "value": "d5",
        "file": {
          "name": "Licence.pdf",
          "size": 182000,
          "content_type": "application/pdf",
          "previewable": true
        }
      }
    ],
    "job": {
      "id": "j1",
      "valid_from": "2024-01-15",
      "valid_to": null,
      "title": "Engineer",
      "title_id": "t1",
      "display_title": null,
      "unit": {
        "id": "u2",
        "name": "Engineering"
      },
      "manager": {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      },
      "location": {
        "id": "l1",
        "name": "Head office"
      },
      "legal_entity": {
        "id": "e1",
        "name": "Acme Lda"
      },
      "employment_type": "full_time",
      "fte": 1,
      "reason": "hire",
      "end_reason": null,
      "leaving_type": null,
      "told": null,
      "contract_type": "fixed_term",
      "contract_end_date": "2026-01-14",
      "probation_end_date": "2024-07-14",
      "weekly_hours": 40,
      "notice_period_days": 30,
      "custom": [
        {
          "key": "shift_pattern",
          "label": "Shift pattern",
          "type": "select",
          "tier": "job",
          "value": "Day"
        }
      ]
    },
    "history": [
      {
        "id": "j1",
        "valid_from": "2024-01-15",
        "valid_to": null,
        "title": "Engineer",
        "title_id": "t1",
        "display_title": null,
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "manager": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "location": {
          "id": "l1",
          "name": "Head office"
        },
        "legal_entity": {
          "id": "e1",
          "name": "Acme Lda"
        },
        "employment_type": "full_time",
        "fte": 1,
        "reason": "hire",
        "end_reason": null,
        "leaving_type": null,
        "told": null,
        "contract_type": "fixed_term",
        "contract_end_date": "2026-01-14",
        "probation_end_date": "2024-07-14",
        "weekly_hours": 40,
        "notice_period_days": 30,
        "custom": [
          {
            "key": "shift_pattern",
            "label": "Shift pattern",
            "type": "select",
            "tier": "job",
            "value": "Day"
          }
        ]
      }
    ],
    "reports": [],
    "visible_tiers": [
      "public",
      "private",
      "job",
      "pay"
    ],
    "planned": null,
    "missing": [],
    "dotted_managers": [
      {
        "id": "p7",
        "name": "João Pereira",
        "title": "Sales Lead",
        "photo_url": null
      }
    ],
    "dotted_reports": []
  }
}

My team#

POST/v1/org/me.teamRead

Returns your manager, your peers (people with the same manager) and your direct reports, as of today. For managers, summary covers your whole reporting line (all levels) as on the My team Home: team_size and change_since_jan, direct reports with how many people work under each, probation ends (60 days) and contract ends (90 days), open checklists about people in the line, change requests waiting for your decision and starts and last days in the next 60 days. Public and job details only, never pay or private details; summary is null without direct reports.

Who can call it
Me key anyone
MCP tool
org_me_team on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • managerobject | nullrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • peersobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • reportsobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • dotted_reportsobject[]required
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • summaryobject | nullrequired
    9 fields
    • team_sizeintegerrequired
    • change_since_janintegerrequired
    • reportsobject[]required
      2 fields
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • people_underintegerrequired
    • probationobject[]required
      2 fields
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • datestringrequired
    • contract_endsobject[]required
      2 fields
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • datestringrequired
    • checklistsobject[]required
      6 fields
      • idstringrequired
      • namestringrequired
      • kind"onboarding" | "offboarding" | "custom"required
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • anchor_datestringrequired
      • progressobjectrequired
        3 fields
        • doneintegerrequired
        • skippedintegerrequired
        • totalintegerrequired
    • to_tellobject[]required
      3 fields
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • datestringrequired
      • last_daystringrequired
    • approvals_waitingintegerrequired
    • comingobject[]required
      5 fields
      • kind"starts" | "last_day" | "probation_ends" | "contract_ends" | "job_change"required
      • datestringrequired
      • personobjectrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • reasonstring | nullrequired
      • titlestring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.team \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "manager": null,
    "peers": [
      {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      }
    ],
    "reports": [
      {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      }
    ],
    "dotted_reports": [
      {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      }
    ],
    "summary": {
      "team_size": 4,
      "change_since_jan": 1,
      "reports": [
        {
          "person": {
            "id": "p2",
            "name": "Rui Costa",
            "title": "CTO",
            "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
          },
          "people_under": 2
        }
      ],
      "probation": [
        {
          "person": {
            "id": "p2",
            "name": "Rui Costa",
            "title": "CTO",
            "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
          },
          "date": "2026-10-30"
        }
      ],
      "contract_ends": [],
      "checklists": [
        {
          "id": "r1",
          "name": "Onboarding",
          "kind": "onboarding",
          "person": {
            "id": "p2",
            "name": "Rui Costa",
            "title": "CTO",
            "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
          },
          "anchor_date": "2026-10-27",
          "progress": {
            "done": 4,
            "skipped": 0,
            "total": 9
          }
        }
      ],
      "to_tell": [
        {
          "person": {
            "id": "p2",
            "name": "Rui Costa",
            "title": "CTO",
            "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
          },
          "date": "2026-11-23",
          "last_day": "2026-11-30"
        }
      ],
      "approvals_waiting": 1,
      "coming": [
        {
          "kind": "starts",
          "date": "2026-10-27",
          "person": {
            "id": "p2",
            "name": "Rui Costa",
            "title": "CTO",
            "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
          },
          "reason": null,
          "title": null
        }
      ]
    }
  }
}

Ask HR to change how my title shows#

POST/v1/org/me.request_profile_titleWrite

Asks HR to show a different title on your profile, the org chart and the directory (display_title, up to 120 characters), or to show your job title again (null). Your job title in the catalog, and reports, stay as they are. HR decides it in Bizisy, always, and it changes once approved; one request at a time (owners, admins and HR signed in to Bizisy change their own at once). Only about yourself, with a current job.

Who can call it
Me key anyone
MCP tool
org_me_request_profile_title on My Workplace
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • display_titlestring | nullrequired

    1–120 characters.

Returns

  • approvalobject | nullrequired
    11 fields
    • idstringrequired
    • status"pending" | "approved"required
    • waiting_for"manager" | "hr"required
    • approversstring[]required
    • automaticbooleanrequired
    • note"proposed_by_approver" | "no_other_approver"required
    • fallbackbooleanrequired
    • team_leadobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • reason"no_manager" | "manager_left"required
    • team_lead_blockedobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • what"lead" | "removed" | "moved" | "archived"required
    • untrusted"no_login" | "invited_by_proposer"required
    • then"manager" | "hr"required

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.request_profile_title \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"display_title":"Backend Wizard"}'
Response
{
  "data": {
    "approval": {
      "id": "apr3",
      "status": "pending",
      "waiting_for": "hr",
      "approvers": [
        "Ana Ferreira"
      ],
      "automatic": false,
      "note": null,
      "fallback": false,
      "then": null,
      "team_lead": null,
      "team_lead_blocked": null,
      "untrusted": null
    }
  }
}

Give my details (invited)#

POST/v1/org/me.set_detailsWrite

For someone invited by email who is still waiting to be registered (org_me_get status invited): sets your given_name and family_name at once, and suggests your job title and start_date (YYYY-MM-DD) for HR to confirm (one request, decided by HR in Bizisy; note optional). Title and start date HR already set are theirs: refused. You are registered automatically once names, title and start date are known. Other details (phones, address, payroll, emergency contacts): org_me_update.

Who can call it
Me key anyone
MCP tool
org_me_set_details on My Workplace
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

  • given_namestring

    1–100 characters.

  • family_namestring

    1–100 characters.

  • titlestring

    1–120 characters.

  • start_datestring
  • notestring

    Up to 500 characters.

Returns

  • personobjectrequired
    35 fields
    • idstringrequired
    • namestringrequired
    • given_namestringrequired
    • family_namestringrequired
    • preferred_namestring | nullrequired
    • work_emailstringrequired
    • titlestring | nullrequired
    • status"invited" | "pre_hire" | "active" | "terminated" | "none"required

      invited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.

    • start_datestring | nullrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • invitedbooleanrequired
    • has_loginbooleanrequired
    • photo_urlstring | nullrequired
    • pronounsstring | nullrequired
    • work_phonestring | nullrequired
    • personal_emailstring | nullrequired
    • personal_phonestring | nullrequired
    • addressobject | nullrequired
      5 fields
      • line1stringrequired
      • line2string
      • citystringrequired
      • postal_codestring
      • countrystringrequired
    • birthdaystring | nullrequired
    • sex"female" | "male" | "another" | "undisclosed"required

      For equal-pay reporting only (private: the person, owners, admins and HR in the app). female and male are compared; another and undisclosed are counted, not compared.

    • emergency_contactsobject[] | nullrequired
      3 fields
      • namestringrequired
      • relationshipstringrequired
      • phonestringrequired
    • tax_idstring | nullrequired
    • social_security_numberstring | nullrequired
    • ibanstring | nullrequired
    • customobject[]required
      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • jobobject | nullrequired
      23 fields
      • idstringrequired
      • valid_fromstringrequired
      • valid_tostring | nullrequired
      • titlestringrequired

        The job title as the catalog names it now (reports and grouping use this).

      • title_idstring | nullrequired

        The catalog title (org_titles_list); null while not in the catalog yet.

      • display_titlestring | nullrequired

        A different title shown on the profile, chart and directory; null: the catalog title.

      • unitobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • managerobject | nullrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • locationobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • legal_entityobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • employment_type"full_time" | "part_time" | "contractor" | "intern"required
      • ftenumberrequired
      • reasonstringrequired
      • end_reasonstring | nullrequired
      • leaving_typestring (enum)required

        Why the employment ended (structured); null: not recorded or still employed.

        One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

      • toldboolean | nullrequired

        With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

      • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
      • contract_end_datestring | nullrequired
      • probation_end_datestring | nullrequired
      • weekly_hoursnumber | nullrequired
      • notice_period_daysinteger | nullrequired
      • customobject[]required

        Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

        7 fields
        • keystringrequired
        • labelstringrequired
        • typestring (enum)required

          One of: text, number, date, select, boolean, file, person, table.

        • tier"public" | "job" | "private"required
        • valuestring | number | boolean | object[]required

          For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

        • fileobject | null

          Type file only: the file, or null when none is attached.

          4 fields
          • namestring | nullrequired

            The file name; null over an API key or MCP for someone else's file.

          • sizeintegerrequired
          • content_typestringrequired
          • previewablebooleanrequired

            The web app can show it (PDF, PNG, JPEG, WebP).

        • personobject | null

          Type person only: who it names (null when not set, or not someone you may see).

          4 fields
          • idstringrequired
          • namestringrequired
          • titlestring | nullrequired
          • photo_urlstring | nullrequired
      • regrettedboolean | null

        Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

    • historyobject[] | nullrequired
      23 fields
      • idstringrequired
      • valid_fromstringrequired
      • valid_tostring | nullrequired
      • titlestringrequired

        The job title as the catalog names it now (reports and grouping use this).

      • title_idstring | nullrequired

        The catalog title (org_titles_list); null while not in the catalog yet.

      • display_titlestring | nullrequired

        A different title shown on the profile, chart and directory; null: the catalog title.

      • unitobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • managerobject | nullrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • locationobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • legal_entityobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • employment_type"full_time" | "part_time" | "contractor" | "intern"required
      • ftenumberrequired
      • reasonstringrequired
      • end_reasonstring | nullrequired
      • leaving_typestring (enum)required

        Why the employment ended (structured); null: not recorded or still employed.

        One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

      • toldboolean | nullrequired

        With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

      • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
      • contract_end_datestring | nullrequired
      • probation_end_datestring | nullrequired
      • weekly_hoursnumber | nullrequired
      • notice_period_daysinteger | nullrequired
      • customobject[]required

        Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

        7 fields
        • keystringrequired
        • labelstringrequired
        • typestring (enum)required

          One of: text, number, date, select, boolean, file, person, table.

        • tier"public" | "job" | "private"required
        • valuestring | number | boolean | object[]required

          For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

        • fileobject | null

          Type file only: the file, or null when none is attached.

          4 fields
          • namestring | nullrequired

            The file name; null over an API key or MCP for someone else's file.

          • sizeintegerrequired
          • content_typestringrequired
          • previewablebooleanrequired

            The web app can show it (PDF, PNG, JPEG, WebP).

        • personobject | null

          Type person only: who it names (null when not set, or not someone you may see).

          4 fields
          • idstringrequired
          • namestringrequired
          • titlestring | nullrequired
          • photo_urlstring | nullrequired
      • regrettedboolean | null

        Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

    • reportsobject[]required
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • visible_tiers"public" | "private" | "job" | "pay"[]required
    • plannedobject | nullrequired

      While invited (status invited): the job details known so far (job tier; null otherwise or when not visible).

      14 fields
      • titlestring | nullrequired
      • title_idstring | nullrequired
      • start_datestring | nullrequired
      • unitobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • managerobject | nullrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • locationobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • legal_entityobject | nullrequired
        2 fields
        • idstringrequired
        • namestringrequired
      • employment_type"full_time" | "part_time" | "contractor" | "intern"required
      • ftenumber | nullrequired
      • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
      • contract_end_datestring | nullrequired
      • probation_end_datestring | nullrequired
      • weekly_hoursnumber | nullrequired
      • notice_period_daysinteger | nullrequired
    • missing"given_name" | "family_name" | "title" | "start_date"[]required

      While invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.

    • dotted_managersobject[]required

      Dotted-line managers today (spec structure-over-time D10): they see job details, never approve.

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • dotted_reportsobject[]required

      People this person has a dotted line to today.

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
  • registeredbooleanrequired

    True when this call registered them (their first job row was written).

  • missing"given_name" | "family_name" | "title" | "start_date"[]required

    What is still needed to register them; [] once registered.

  • approvalobject | nullrequired

    Your suggested title and start date, waiting for HR.

    11 fields
    • idstringrequired
    • status"pending" | "approved"required
    • waiting_for"manager" | "hr"required
    • approversstring[]required
    • automaticbooleanrequired
    • note"proposed_by_approver" | "no_other_approver"required
    • fallbackbooleanrequired
    • team_leadobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • reason"no_manager" | "manager_left"required
    • team_lead_blockedobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • what"lead" | "removed" | "moved" | "archived"required
    • untrusted"no_login" | "invited_by_proposer"required
    • then"manager" | "hr"required

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.set_details \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "given_name": "Rita",
  "family_name": "Sousa",
  "title": "Designer",
  "start_date": "2026-11-02",
  "note": "As agreed with Rui."
}'
Response
{
  "data": {
    "person": {
      "id": "p9",
      "name": "Rita Sousa",
      "given_name": "Rita",
      "family_name": "Sousa",
      "preferred_name": null,
      "work_email": "rita@acme.test",
      "title": null,
      "status": "invited",
      "start_date": null,
      "unit": null,
      "location": null,
      "manager": null,
      "invited": true,
      "has_login": false,
      "photo_url": null,
      "pronouns": "she/her",
      "work_phone": "+351 210 000 000",
      "personal_email": null,
      "personal_phone": null,
      "address": {
        "line1": "Rua Augusta 100",
        "city": "Lisboa",
        "country": "PT"
      },
      "birthday": "1990-04-10",
      "sex": "female",
      "emergency_contacts": [
        {
          "name": "Rui",
          "relationship": "Partner",
          "phone": "+351 911 000 000"
        }
      ],
      "tax_id": "123456789",
      "social_security_number": null,
      "iban": "PT50000201231234567890154",
      "custom": [
        {
          "key": "t_shirt_size",
          "label": "T-shirt size",
          "type": "select",
          "tier": "public",
          "value": "M"
        },
        {
          "key": "remote",
          "label": "Remote allowance",
          "type": "boolean",
          "tier": "job",
          "value": null
        },
        {
          "key": "driving_licence",
          "label": "Driving licence",
          "type": "file",
          "tier": "private",
          "value": "d5",
          "file": {
            "name": "Licence.pdf",
            "size": 182000,
            "content_type": "application/pdf",
            "previewable": true
          }
        }
      ],
      "job": null,
      "history": [],
      "reports": [],
      "visible_tiers": [
        "public",
        "private",
        "job",
        "pay"
      ],
      "planned": {
        "title": "Designer",
        "title_id": null,
        "start_date": null,
        "unit": null,
        "manager": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "location": null,
        "legal_entity": null,
        "employment_type": null,
        "fte": null,
        "contract_type": null,
        "contract_end_date": null,
        "probation_end_date": null,
        "weekly_hours": null,
        "notice_period_days": null
      },
      "missing": [
        "start_date"
      ],
      "dotted_managers": [
        {
          "id": "p7",
          "name": "João Pereira",
          "title": "Sales Lead",
          "photo_url": null
        }
      ],
      "dotted_reports": []
    },
    "registered": false,
    "missing": [
      "start_date"
    ],
    "approval": {
      "id": "a9",
      "status": "pending",
      "waiting_for": "hr",
      "approvers": [
        "Ana Ferreira"
      ],
      "automatic": false,
      "note": null,
      "fallback": false,
      "then": null,
      "team_lead": null,
      "team_lead_blocked": null,
      "untrusted": null
    }
  }
}

People joining my team#

POST/v1/org/team.joiningRead

Lists people invited by email who are planned to report to you and are still waiting for their details: name (or work email), what is known (title, start date) and what is missing; waiting is true while suggested details wait for HR. Suggest their details with org_team_suggest_details.

Who can call it
Me key anyone
MCP tool
org_team_joining on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

An array of objects with 7 fields

An array of objects:

  • idstringrequired
  • namestringrequired
  • work_emailstringrequired
  • titlestring | nullrequired
  • start_datestring | nullrequired
  • missing"given_name" | "family_name" | "title" | "start_date"[]required
  • waitingbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.joining \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": [
    {
      "id": "p9",
      "name": "rita@acme.test",
      "work_email": "rita@acme.test",
      "title": "Designer",
      "start_date": null,
      "missing": [
        "given_name",
        "family_name",
        "start_date"
      ],
      "waiting": false
    }
  ]
}

Suggest details for someone joining my team#

POST/v1/org/team.suggest_detailsWrite

For a person invited by email who is planned to report to you (org_team_joining): suggests their job title, start_date (YYYY-MM-DD) and unit_id, with an optional note. One request, always decided by HR in Bizisy; the person does not see it. Refused when HR already set that detail or a suggestion is waiting.

Who can call it
Me key anyone
MCP tool
org_team_suggest_details on My Workplace
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • person_idstringrequired
  • titlestring

    1–120 characters.

  • start_datestring
  • unit_idstring
  • notestring

    Up to 500 characters.

Returns

  • approvalobjectrequired
    11 fields
    • idstringrequired
    • status"pending" | "approved"required
    • waiting_for"manager" | "hr"required
    • approversstring[]required
    • automaticbooleanrequired
    • note"proposed_by_approver" | "no_other_approver"required
    • fallbackbooleanrequired
    • team_leadobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • reason"no_manager" | "manager_left"required
    • team_lead_blockedobject | nullrequired
      3 fields
      • unit_idstringrequired
      • unit_namestringrequired
      • what"lead" | "removed" | "moved" | "archived"required
    • untrusted"no_login" | "invited_by_proposer"required
    • then"manager" | "hr"required

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.suggest_details \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "person_id": "p9",
  "title": "Designer",
  "start_date": "2026-11-02",
  "unit_id": "u2",
  "note": "Joins the design team."
}'
Response
{
  "data": {
    "approval": {
      "id": "a9",
      "status": "pending",
      "waiting_for": "hr",
      "approvers": [
        "Ana Ferreira"
      ],
      "automatic": false,
      "note": null,
      "fallback": false,
      "then": null,
      "team_lead": null,
      "team_lead_blocked": null,
      "untrusted": null
    }
  }
}

Export my data#

POST/v1/org/me.export_dataRead

Returns everything Bizisy holds about you in this organization as JSON (your right of access): profile, profile photo (base64), the documents shared with you (metadata, plus document_files: 5-minute download links), job history, a last day still ahead once you have been told about it (planned_last_day), pay history, variable pay imported for a draft pay gap report, your requests about pay levels and the answers, invites, your logins, API keys (names and dates, never secrets), your Activity, open positions you filled or are recorded as replaced in (those you may see), decided change requests about you (approvals), your checklists (about you, tasks assigned to you, and your comments), the equipment you hold and held, your time off (bookings, requests, notes, decisions, balance adjustments), your payroll data (employee number, pay periods you were in, variable pay, net pay) and webhook deliveries about you in the last 30 days.

Who can call it
Me key anyone
MCP tool
org_me_export_data on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

61 fields
  • format"bizisy.person-data.v1"required
  • generated_atstringrequired
  • organization_idstringrequired
  • personobjectrequired
  • photoobject | nullrequired
    3 fields
    • content_typestringrequired
    • data_base64stringrequired
    • updated_atstringrequired
  • jobsobject[]required
    23 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • titlestringrequired

      The job title as the catalog names it now (reports and grouping use this).

    • title_idstring | nullrequired

      The catalog title (org_titles_list); null while not in the catalog yet.

    • display_titlestring | nullrequired

      A different title shown on the profile, chart and directory; null: the catalog title.

    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • managerobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • locationobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • legal_entityobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • employment_type"full_time" | "part_time" | "contractor" | "intern"required
    • ftenumberrequired
    • reasonstringrequired
    • end_reasonstring | nullrequired
    • leaving_typestring (enum)required

      Why the employment ended (structured); null: not recorded or still employed.

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • toldboolean | nullrequired

      With a termination (end_reason): whether the person has been told about this last day; false: only HR and their manager know, until org_people_mark_told or the day passes. null on other rows.

    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • contract_end_datestring | nullrequired
    • probation_end_datestring | nullrequired
    • weekly_hoursnumber | nullrequired
    • notice_period_daysinteger | nullrequired
    • customobject[]required

      Job custom fields (target job) on this row, effective-dated: each job row keeps its own values. Only for those who see the job details.

      7 fields
      • keystringrequired
      • labelstringrequired
      • typestring (enum)required

        One of: text, number, date, select, boolean, file, person, table.

      • tier"public" | "job" | "private"required
      • valuestring | number | boolean | object[]required

        For type file: the document id (download it with documents_download or documents_me_download); over an API key or MCP, "attached" for someone else's file. For type person: the person id. For type table: the rows, [{ <column key>: value }] (columns in org_fields_list).

      • fileobject | null

        Type file only: the file, or null when none is attached.

        4 fields
        • namestring | nullrequired

          The file name; null over an API key or MCP for someone else's file.

        • sizeintegerrequired
        • content_typestringrequired
        • previewablebooleanrequired

          The web app can show it (PDF, PNG, JPEG, WebP).

      • personobject | null

        Type person only: who it names (null when not set, or not someone you may see).

        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • regrettedboolean | null

      Private (people analytics): on the row a voluntary termination ends, whether HR marked the leaver as regretted (null: not set). Only owners, admins and HR in the app see it; absent for everyone else.

  • planned_last_dayobject | null

    A last day still ahead (a termination recorded, the day not passed): the day itself, the leaving type and reason, and whether the person has been told. Their own copy has it once they have been told (spec told-about-last-day T3, GDPR art. 15); null: none ahead, or not told yet in their own copy.

    5 fields
    • last_daystringrequired
    • leaving_typestring (enum)required

      One of: resignation, retirement, dismissal, redundancy, end_of_contract, mutual_agreement, death, other.

    • reasonstring | nullrequired
    • toldbooleanrequired

      false: not told yet (HR's export only: their own copy leaves it out until they are told).

    • recorded_atstringrequired
  • payobject[]required
    8 fields
    • idstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • amountnumberrequired
    • currencystringrequired
    • period"year" | "month" | "hour"required
    • notestring | nullrequired
    • created_atstringrequired
  • invitesobject[]required
    6 fields
    • emailstringrequired
    • rolestringrequired
    • created_atstringrequired
    • expires_atstringrequired
    • accepted_atstring | nullrequired
    • revoked_atstring | nullrequired
  • loginsobject[]required
  • api_keysobject[]required
  • connected_appsobject[]required
  • dpa_acceptancesobject[]
  • activityobject[]required
  • activity_truncatedbooleanrequired
  • change_historyobject[]required
    8 fields
    • idstringrequired
    • entry_idstringrequired
    • atstringrequired
    • op"insert" | "update" | "delete"required
    • recordobjectrequired
      4 fields
      • kindstringrequired
      • idstringrequired
      • namestring | nullrequired
      • datestring | nullrequired
    • person_idsstring[]required
    • fieldsobject[]required
      6 fields
      • keystringrequired
      • labelstring | nullrequired
      • tier"public" | "job" | "private" | "pay" | "hr"required
      • beforeobjectrequired
        27 fields (one of several shapes)

        Option 1

        • t"text"required
        • vstringrequired

        Option 2

        • t"number"required
        • vnumberrequired

        Option 3

        • t"bool"required
        • vbooleanrequired

        Option 4

        • t"date"required
        • vstringrequired

        Option 5

        • t"datetime"required
        • vstringrequired

        Option 6

        • t"money"required
        • amountnumberrequired
        • currencystringrequired
        • periodstring | nullrequired

        Option 7

        • t"ref"required
        • kindstring (enum)required

          One of: person, unit, location, title, entity, position, family, level, category, field, document, checklist.

        • idstringrequired
        • namestring | nullrequired

        Option 8

        • t"enum"required
        • setstringrequired
        • vstringrequired

        Option 9

        • t"list"required
        • itemsany[]required

        Option 10

        • t"file"required
        • namestring | nullrequired
        • sizenumber | nullrequired

        Option 11

        • t"secret"required
      • afterobjectrequired
        27 fields (one of several shapes)

        Option 1

        • t"text"required
        • vstringrequired

        Option 2

        • t"number"required
        • vnumberrequired

        Option 3

        • t"bool"required
        • vbooleanrequired

        Option 4

        • t"date"required
        • vstringrequired

        Option 5

        • t"datetime"required
        • vstringrequired

        Option 6

        • t"money"required
        • amountnumberrequired
        • currencystringrequired
        • periodstring | nullrequired

        Option 7

        • t"ref"required
        • kindstring (enum)required

          One of: person, unit, location, title, entity, position, family, level, category, field, document, checklist.

        • idstringrequired
        • namestring | nullrequired

        Option 8

        • t"enum"required
        • setstringrequired
        • vstringrequired

        Option 9

        • t"list"required
        • itemsany[]required

        Option 10

        • t"file"required
        • namestring | nullrequired
        • sizenumber | nullrequired

        Option 11

        • t"secret"required
      • hiddenbooleanrequired
    • truncatedbooleanrequired
  • change_history_truncatedbooleanrequired
  • notificationsobject[]required
    3 fields
    • typestringrequired
    • created_atstringrequired
    • read_atstring | nullrequired
  • home_preferencesobject[]required
    4 fields
    • managestring | nullrequired
    • mestring | nullrequired
    • pinsobjectrequired
      2 fields
      • managestring[]required
      • mestring[]required
    • updated_atstringrequired
  • directory_accountsobject[]required
    3 fields
    • providerstringrequired
    • accountstring | nullrequired
    • excludedbooleanrequired
  • spend_accountsobject[]required

    Their account in each connected spend tool (Pleo, Moss, Payhawk, Spendesk) as Bizisy last read it.

    4 fields
    • toolstringrequired
    • accountstring | nullrequired
    • statestring | nullrequired
    • excludedbooleanrequired
  • recruitingobject[]required

    The recruiting tool application they were hired from (Teamtailor, Greenhouse).

    3 fields
    • toolstringrequired
    • application_idstringrequired
    • received_atstringrequired
  • announcementsobject[]required
    5 fields
    • toolstringrequired
    • kindstringrequired
    • daystringrequired
    • statusstringrequired
    • posted_atstring | nullrequired
  • remindersobject[]required
    3 fields
    • kindstringrequired
    • datestringrequired
    • sent_atstringrequired
  • occupational_health_checkobject | nullrequired

    The dates HR keeps (never a result).

    2 fields
    • last_onstring | nullrequired
    • next_due_set_by_hrstring | nullrequired
  • check_insobjectrequired
    6 fields
    • one_on_onesobject[]required
      7 fields
      • role"person" | "manager"required
      • kindstringrequired
      • withstringrequired
      • cadencestringrequired
      • first_datestringrequired
      • last_heldstring | nullrequired
      • endedbooleanrequired
    • meetingsobject[]required
      3 fields
      • role"person" | "manager"required
      • datestringrequired
      • statusstringrequired
    • pointsobject[]required
      9 fields
      • role"person" | "manager"required
      • kindstringrequired
      • textstringrequired
      • bystringrequired
      • ownerstring | nullrequired
      • duestring | nullrequired
      • done_onstring | nullrequired
      • held_onstring | nullrequired
      • notesstring | nullrequired
    • notesobject[]required
      4 fields
      • datestringrequired
      • textstringrequired
      • written_by"them" | "the other side"required
      • ratingstring | nullrequired
    • quarterlyobject[]required
      3 fields
      • periodstringrequired
      • selfobject | nullrequired
        3 fields
        • answersobject[]required
          3 fields
          • question_idstringrequired
          • questionstringrequired
          • textstringrequired
        • ratinginteger | nullrequired
        • submitted_atstring | nullrequired
      • managerobject | nullrequired
        3 fields
        • answersobject[]required
          3 fields
          • question_idstringrequired
          • questionstringrequired
          • textstringrequired
        • ratinginteger | nullrequired
        • submitted_atstring | nullrequired
    • exemptionsobject[]required
      4 fields
      • statusstringrequired
      • justificationstringrequired
      • untilstring | nullrequired
      • created_atstringrequired
  • company_announcementsobjectrequired

    Announcements published to the person (with when they saw and acknowledged each) and those they posted.

    2 fields
    • receivedobject[]required
      7 fields
      • titlestringrequired
      • published_atstring | nullrequired
      • requires_ackbooleanrequired
      • seen_atstring | nullrequired
      • acknowledged_atstring | nullrequired
      • via"app" | "kiosk"required
      • fingerprintstring | nullrequired
    • postedobject[]required
      4 fields
      • titlestringrequired
      • statusstringrequired
      • created_atstringrequired
      • published_atstring | nullrequired
  • positionsobject[]required
    4 fields
    • idstringrequired
    • titlestringrequired
    • statusstringrequired
    • role"filled" | "replaced"required
  • role_requestsobject[]required
    5 fields
    • titlestringrequired
    • kind"new" | "backfill"required
    • statusstringrequired
    • notestring | nullrequired
    • asked_atstringrequired
  • dotted_linesobject[]required
    6 fields
    • role"person" | "manager"required
    • personstringrequired
    • managerstringrequired
    • valid_fromstringrequired
    • valid_tostring | nullrequired
    • notestring | nullrequired
  • approvalsobject[]required
  • saved_draftsobject[]required
    4 fields
    • processstringrequired
    • labelstringrequired
    • dataobjectrequired
    • saved_atstringrequired
  • groupsobject[]required

    Saved groups whose criteria name the person (wave H D19: the reports of this manager). Membership is computed when used, never stored.

    2 fields
    • namestringrequired
    • named_as"manager"required
  • import_rowsobject[]required

    Rows of import runs (kept 30 days) that name the person: HR's export only.

    6 fields
    • import_idstringrequired
    • rownumberrequired
    • outcomestringrequired
    • appliedbooleanrequired
    • cellsstring[] | nullrequired
    • errorsobject[]required
      2 fields
      • columnstring | nullrequired
      • messagestringrequired
  • start_groupsobject[]

    Start groups the person is in (HR's export).

    2 fields
    • namestringrequired
    • start_datestringrequired
  • move_batchesobject[]

    Batches of job changes that include the person (HR's export; their own once the change is announced).

    5 fields
    • batchstringrequired
    • effective_datestringrequired
    • announce_onstringrequired
    • outcomestringrequired
    • problemstring | nullrequired
  • movesobject[]

    Rows of moves from another HR tool (kept 30 days) about the person: HR's export only.

    6 fields
    • run_idstringrequired
    • kindstringrequired
    • outcomestringrequired
    • appliedbooleanrequired
    • problemsstring[]required
    • expires_atstringrequired
  • checklistsobjectrequired
    5 fields
    • about_youobject[]required
      6 fields
      • namestringrequired
      • kindstringrequired
      • statusstringrequired
      • anchor_datestringrequired
      • started_atstringrequired
      • tasksobject[]required
        6 fields
        • titlestringrequired
        • due_datestringrequired
        • statusstringrequired
        • skip_reasonstring | nullrequired
        • resolved_atstring | nullrequired
        • commentsobject[]required
          3 fields
          • textstringrequired
          • atstringrequired
          • by_youbooleanrequired
    • assigned_to_youobject[]required
      5 fields
      • checkliststringrequired
      • titlestringrequired
      • due_datestringrequired
      • statusstringrequired
      • resolved_atstring | nullrequired
    • your_commentsobject[]required
      4 fields
      • checkliststringrequired
      • taskstringrequired
      • textstringrequired
      • atstringrequired
    • resolved_by_youobject[]required
      5 fields
      • checkliststringrequired
      • taskstringrequired
      • statusstringrequired
      • skip_reasonstring | nullrequired
      • resolved_atstring | nullrequired
    • template_tasksobject[]required
      2 fields
      • templatestringrequired
      • taskstringrequired
  • webhook_deliveriesobject[]required
    4 fields
    • event_typestringrequired
    • endpoint_hoststringrequired
    • created_atstringrequired
    • statusstringrequired
  • integration_linksobject[]required
    5 fields
    • toolstringrequired
    • entitystringrequired
    • external_idstringrequired
    • external_urlstring | nullrequired
    • linked_atstringrequired
  • countryobject | nullrequired
    3 fields
    • noticesobject[]required
      6 fields
      • obligationstringrequired
      • event_datestringrequired
      • statusstringrequired
      • channelstring | nullrequired
      • referencestring | nullrequired
      • sent_onstring | nullrequired
    • country_dataobjectrequired
    • vacation_mapsobject[]
      4 fields
      • yearintegerrequired
      • versionintegerrequired
      • posted_onstringrequired
      • periodsobject[]required
        3 fields
        • startstringrequired
        • endstringrequired
        • daysnumberrequired
  • pay_report_inputsobject[]required
    6 fields
    • yearinteger | nullrequired
    • legal_entitystring | nullrequired
    • currencystring | nullrequired
    • bonusnumberrequired
    • allowancesnumberrequired
    • in_kindnumberrequired
  • bank_changesobject[]required
    7 fields
    • new_ibanstringrequired
    • statusstringrequired
    • requested_as"self" | "hr"required
    • created_atstringrequired
    • proofobject | nullrequired
      3 fields
      • content_typestringrequired
      • sizenumberrequired
      • uploaded_atstringrequired
    • verdictobject | nullrequired
      3 fields
      • resultstringrequired
      • reasonsstring[]required
      • checked_atstringrequired
    • decidedobject | nullrequired
      3 fields
      • how"automatic" | "hr"required
      • atstringrequired
      • notestring | nullrequired
  • pay_requestsobject[]required
    9 fields
    • idstringrequired
    • created_atstringrequired
    • due_onstringrequired
    • status"answered" | "open"required
    • answerobjectrequired
      6 fields
      • as_ofstringrequired
      • categoryobject | nullrequired

        Your category of workers: people doing the same work or work of equal value.

        2 fields
        • idstringrequired
        • namestringrequired
      • ownobject | nullrequired

        Your pay level that day: your gross pay in force, annualised (year: as is; month: × 12; hour: × your hours in a year), and per hour (your weekly hours, else FTE × the standard week). Null without pay recorded.

        3 fields
        • annualnumberrequired
        • hourlynumberrequired
        • currencystringrequired
      • womenobject | nullrequired

        Women in your category that day, not counting you, paid in your currency. Null when withheld.

        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • menobject | nullrequired
        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"required

        Why the averages were not given at once, so HR answers in writing within two months: small_group (fewer than the company's minimum of women or of men in your category, not counting you: averages could reveal a colleague's pay), recent_change (since your last answer, fewer than that minimum of people joined or left your category: comparing the two answers could reveal their pay), category_review (a job evaluation of your category is being changed, so HR confirms the category first), no_category (your job is in no pay category yet), no_pay (no pay recorded for you). Null: answered.

    • hr_replystring | nullrequired
    • answered_atstring | nullrequired
    • recorded_by_hrboolean
    • receivedstring | null
  • field_referencesobject[]required
    3 fields
    • fieldstringrequired
    • target"person" | "job" | "unit" | "position"required
    • recordstringrequired
  • documentsobject[]required
  • document_filesobject[]required
    2 fields
    • namestringrequired
    • urlstringrequired
  • payrollobject
  • equipmentobject[]required
    8 fields
    • typestringrequired
    • namestringrequired
    • modelstring | nullrequired
    • serialstring | nullrequired
    • fromstringrequired
    • tostring | nullrequired
    • confirmed_atstring | nullrequired
    • returnedobject | nullrequired
      2 fields
      • conditionstringrequired
      • notestring | nullrequired
  • time_offobject
  • time_clockobject
  • hiringobject
  • trainingobject
  • talentobject
  • compobject
  • insightsobject
  • shiftsobject
  • benefitsobject
  • surveysobject
  • assistantobject
  • filenamestringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.export_data \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "format": "bizisy.person-data.v1",
    "generated_at": "2026-10-04T10:00:00.000Z",
    "organization_id": "o1",
    "filename": "my-data-2026-10-04.json",
    "person": {
      "id": "p1",
      "name": "Ana Ferreira"
    },
    "photo": {
      "content_type": "image/webp",
      "data_base64": "UklGRg==",
      "updated_at": "2026-10-04T10:00:00.000Z"
    },
    "jobs": [
      {
        "id": "j1",
        "valid_from": "2024-01-15",
        "valid_to": null,
        "title": "Engineer",
        "title_id": "t1",
        "display_title": null,
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "manager": {
          "id": "p2",
          "name": "Rui Costa",
          "title": "CTO",
          "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
        },
        "location": {
          "id": "l1",
          "name": "Head office"
        },
        "legal_entity": {
          "id": "e1",
          "name": "Acme Lda"
        },
        "employment_type": "full_time",
        "fte": 1,
        "reason": "hire",
        "end_reason": null,
        "leaving_type": null,
        "told": null,
        "contract_type": "fixed_term",
        "contract_end_date": "2026-01-14",
        "probation_end_date": "2024-07-14",
        "weekly_hours": 40,
        "notice_period_days": 30,
        "custom": [
          {
            "key": "shift_pattern",
            "label": "Shift pattern",
            "type": "select",
            "tier": "job",
            "value": "Day"
          }
        ]
      }
    ],
    "pay": [
      {
        "id": "pay1",
        "valid_from": "2024-01-15",
        "valid_to": null,
        "amount": 42000,
        "currency": "EUR",
        "period": "year",
        "note": null,
        "created_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "pay_report_inputs": [
      {
        "year": 2025,
        "legal_entity": "Acme Lda",
        "currency": "EUR",
        "bonus": 1500,
        "allowances": 0,
        "in_kind": 0
      }
    ],
    "pay_requests": [
      {
        "id": "rq1",
        "created_at": "2026-10-04T10:00:00.000Z",
        "due_on": "2026-12-04",
        "status": "answered",
        "answer": {
          "as_of": "2026-10-04",
          "category": {
            "id": "c1",
            "name": "Engineering"
          },
          "own": {
            "annual": 45000,
            "hourly": 21.58,
            "currency": "EUR"
          },
          "women": {
            "count": 3,
            "annual_mean": 40000,
            "hourly_mean": 19.18
          },
          "men": {
            "count": 4,
            "annual_mean": 52000,
            "hourly_mean": 24.93
          },
          "withheld": null
        },
        "hr_reply": null,
        "answered_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "bank_changes": [
      {
        "new_iban": "PT50000201231234567890154",
        "status": "verified",
        "requested_as": "self",
        "created_at": "2026-10-04T10:00:00.000Z",
        "proof": {
          "content_type": "application/pdf",
          "size": 48211,
          "uploaded_at": "2026-10-04T10:01:00.000Z"
        },
        "verdict": {
          "result": "verified",
          "reasons": [
            "iban_on_document",
            "name_matches"
          ],
          "checked_at": "2026-10-04T10:01:02.000Z"
        },
        "decided": {
          "how": "hr",
          "at": "2026-10-04T11:00:00.000Z",
          "note": null
        }
      }
    ],
    "invites": [
      {
        "email": "ana@acme.test",
        "role": "member",
        "created_at": "2026-10-04T10:00:00.000Z",
        "expires_at": "2026-10-18T10:00:00.000Z",
        "accepted_at": null,
        "revoked_at": null
      }
    ],
    "logins": [
      {
        "email": "ana@acme.test",
        "roles": [
          "hr"
        ]
      }
    ],
    "api_keys": [],
    "connected_apps": [
      {
        "app": "Claude",
        "access": "me"
      }
    ],
    "activity": [
      {
        "at": "2026-10-04T10:00:00.000Z",
        "summary": "Updated your profile"
      }
    ],
    "activity_truncated": false,
    "change_history": [
      {
        "id": "01k0000000000000000000000c",
        "entry_id": "01k0000000000000000000000b",
        "at": "2026-10-04T10:00:00.000Z",
        "op": "update",
        "record": {
          "kind": "job",
          "id": "j1",
          "name": null,
          "date": "2026-11-01"
        },
        "person_ids": [
          "p1"
        ],
        "truncated": false,
        "fields": [
          {
            "key": "title",
            "label": null,
            "tier": "job",
            "before": {
              "t": "text",
              "v": "Engineer"
            },
            "after": {
              "t": "text",
              "v": "Senior Engineer"
            },
            "hidden": false
          },
          {
            "key": "manager_id",
            "label": null,
            "tier": "job",
            "before": {
              "t": "ref",
              "kind": "person",
              "id": "p2",
              "name": "Rui Costa"
            },
            "after": {
              "t": "ref",
              "kind": "person",
              "id": "p3",
              "name": null
            },
            "hidden": false
          },
          {
            "key": "iban",
            "label": null,
            "tier": "private",
            "before": null,
            "after": null,
            "hidden": true
          }
        ]
      }
    ],
    "change_history_truncated": false,
    "notifications": [
      {
        "type": "approval_request",
        "created_at": "2026-10-04T10:00:00.000Z",
        "read_at": null
      }
    ],
    "directory_accounts": [
      {
        "provider": "Google Workspace",
        "account": "ana@acme.test",
        "excluded": false
      },
      {
        "provider": "Okta",
        "account": "ana@acme.test",
        "excluded": false
      }
    ],
    "recruiting": [
      {
        "tool": "Teamtailor",
        "application_id": "81234",
        "received_at": "2025-12-01T09:00:00.000Z"
      }
    ],
    "spend_accounts": [
      {
        "tool": "Payhawk",
        "account": "ana@acme.test",
        "state": "active",
        "excluded": false
      }
    ],
    "announcements": [
      {
        "tool": "Slack",
        "kind": "joiner",
        "day": "2026-01-05",
        "status": "posted",
        "posted_at": "2026-01-05T09:02:00.000Z"
      }
    ],
    "home_preferences": [
      {
        "manage": null,
        "me": "me",
        "pins": {
          "manage": [],
          "me": [
            "page:/tasks"
          ]
        },
        "updated_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "reminders": [
      {
        "kind": "probation_end",
        "date": "2024-07-14",
        "sent_at": "2024-06-30T06:00:00.000Z"
      }
    ],
    "occupational_health_check": null,
    "check_ins": {
      "one_on_ones": [
        {
          "role": "person",
          "kind": "manager",
          "with": "Tomás Silva",
          "cadence": "weekly",
          "first_date": "2026-09-07",
          "last_held": "2026-09-28",
          "ended": false
        }
      ],
      "meetings": [
        {
          "role": "person",
          "date": "2026-09-28",
          "status": "held"
        }
      ],
      "points": [],
      "notes": [
        {
          "date": "2026-09-28",
          "text": "Ask about the course",
          "written_by": "them",
          "rating": "useful"
        }
      ],
      "quarterly": [],
      "exemptions": []
    },
    "company_announcements": {
      "received": [
        {
          "title": "New expense policy",
          "published_at": "2026-10-10T09:00:00.000Z",
          "requires_ack": true,
          "seen_at": "2026-10-10T09:30:00.000Z",
          "acknowledged_at": "2026-10-10T09:31:00.000Z",
          "via": "app",
          "fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
      ],
      "posted": []
    },
    "positions": [
      {
        "id": "pos1",
        "title": "Engineer",
        "status": "filled",
        "role": "filled"
      }
    ],
    "role_requests": [
      {
        "title": "Data Engineer",
        "kind": "backfill",
        "status": "waiting",
        "note": "Rui leaves at the end of November.",
        "asked_at": "2026-10-03T09:00:00.000Z"
      }
    ],
    "field_references": [
      {
        "field": "Buddy",
        "target": "person",
        "record": "Bea Silva"
      }
    ],
    "dotted_lines": [
      {
        "role": "person",
        "person": "Ana Ferreira",
        "manager": "João Pereira",
        "valid_from": "2026-01-05",
        "valid_to": null,
        "note": "Platform project"
      }
    ],
    "approvals": [
      {
        "kind": "job_change",
        "status": "approved",
        "effective_date": "2026-11-01",
        "proposed_at": "2026-10-04T10:00:00.000Z",
        "closed_at": "2026-10-05T09:00:00.000Z",
        "change": {
          "title": "Senior Engineer"
        },
        "steps": [
          {
            "role": "hr",
            "state": "approved",
            "decided_at": "2026-10-05T09:00:00.000Z",
            "comment": null,
            "automatic": false
          }
        ]
      }
    ],
    "saved_drafts": [],
    "groups": [
      {
        "name": "Engineering managers",
        "named_as": "manager"
      }
    ],
    "import_rows": [],
    "checklists": {
      "about_you": [
        {
          "name": "Onboarding",
          "kind": "onboarding",
          "status": "completed",
          "anchor_date": "2024-03-04",
          "started_at": "2024-02-20T10:00:00.000Z",
          "tasks": [
            {
              "title": "Get set up in Bizisy",
              "due_date": "2024-03-04",
              "status": "done",
              "skip_reason": null,
              "resolved_at": "2024-03-04T09:00:00.000Z",
              "comments": [
                {
                  "text": "Done on day one",
                  "at": "2024-03-04T09:00:00.000Z",
                  "by_you": true
                }
              ]
            }
          ]
        }
      ],
      "assigned_to_you": [
        {
          "checklist": "Onboarding",
          "title": "Plan the first week",
          "due_date": "2026-10-31",
          "status": "open",
          "resolved_at": null
        }
      ],
      "your_comments": [
        {
          "checklist": "Onboarding",
          "task": "Plan the first week",
          "text": "Agenda shared",
          "at": "2026-10-04T10:00:00.000Z"
        }
      ],
      "resolved_by_you": [
        {
          "checklist": "Onboarding",
          "task": "Plan the first week",
          "status": "done",
          "skip_reason": null,
          "resolved_at": "2026-10-04T10:00:00.000Z"
        }
      ],
      "template_tasks": [
        {
          "template": "IT onboarding",
          "task": "Laptop"
        }
      ]
    },
    "webhook_deliveries": [
      {
        "event_type": "person.hired",
        "endpoint_host": "hooks.example.com",
        "created_at": "2026-10-04T10:01:00.000Z",
        "status": "succeeded"
      }
    ],
    "integration_links": [],
    "country": {
      "notices": [
        {
          "obligation": "pt.hire",
          "event_date": "2026-10-20",
          "status": "sent",
          "channel": "webservice",
          "reference": null,
          "sent_on": "2026-10-12"
        }
      ],
      "country_data": {
        "nationality": "PT"
      }
    },
    "documents": [
      {
        "id": "d1",
        "title": "Contract 2026",
        "category": "Contract",
        "file": "documents/people/p1/d1-Contract 2026.pdf"
      }
    ],
    "document_files": [
      {
        "name": "documents/people/p1/d1-Contract 2026.pdf",
        "url": "https://storage.googleapis.com/b/orgs/o1/files/d1?X-Goog-Signature=x"
      }
    ],
    "equipment": [
      {
        "type": "laptop",
        "name": "MacBook Pro 14",
        "model": "MacBookPro18,3",
        "serial": "C02XY123",
        "from": "2026-01-05",
        "to": null,
        "confirmed_at": "2026-01-05T10:00:00.000Z",
        "returned": null
      }
    ]
  }
}

Upload my photo#

POST/v1/org/me.photo.uploadWrite

Sets your own profile photo. The image (image_base64: the file as base64) must be a JPEG, PNG or WebP of at most 2 MB and 24 megapixels (over MCP the request is limited to 2 MiB, so about 1.5 MB; send larger files through the REST API); the server checks the bytes, centre-crops it to a square, re-encodes it as a 512×512 WebP and drops all metadata (EXIF, location). A new upload replaces the old photo. The photo is visible to everyone in the organization who can see the person (public tier, also over the API and MCP as photo_url); never outside it. Returns the new photo_url. Errors: not_found when your login is not linked to a person, validation_failed for a bad image, rate_limited when the server is busy with other images (retry in a few seconds). Use dry_run first and confirm with the user.

Who can call it
Me key anyone
MCP tool
org_me_photo_upload on My Workplace
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
Body limit
3 MiB (other actions: 2 MiB)

Input

  • image_base64stringrequired

    The image file as base64 (a data: URL is accepted): JPEG, PNG or WebP, at most 2 MB. Square images work best; the server centre-crops.

    1–2900000 characters.

Returns

  • person_idstringrequired
  • photo_urlstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict payload_too_large rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.photo.upload \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"image_base64":"UklGRg=="}'
Response
{
  "data": {
    "person_id": "p1",
    "photo_url": "https://acme.bizisy.com/api/photos/people/p1?v=01k0000000000000000000000d"
  }
}

Remove my photo#

POST/v1/org/me.photo.removeDestructive

Deletes your own profile photo; your initials show instead. Succeeds when there is no photo.

Who can call it
Me key anyone
MCP tool
org_me_photo_remove on My Workplace
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

No input: send {}.

Returns

  • person_idstringrequired
  • photo_urlstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.photo.remove \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Response
{
  "data": {
    "person_id": "p1",
    "photo_url": null
  }
}

Checklists I can start for my team#

POST/v1/org/team.checklist_templatesRead

The custom checklist templates HR lets managers start for people in their team (Settings → Checklists, "Managers can start it"): name and tasks (title, who does it: hr, manager, person or member, and offset_days from the date you choose). Empty when you have nobody reporting to you. Start one with org_team_start_checklist.

Who can call it
Me key anyone
MCP tool
org_team_checklist_templates on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • templatesobject[]required
    3 fields
    • idstringrequired
    • namestringrequired
    • tasksobject[]required
      3 fields
      • titlestringrequired
      • assignee"hr" | "manager" | "person" | "member"required
      • offset_daysintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.checklist_templates \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "templates": [
      {
        "id": "t9",
        "name": "Return from leave",
        "tasks": [
          {
            "title": "Catch-up with your manager",
            "assignee": "manager",
            "offset_days": 0
          },
          {
            "title": "Reactivate tools",
            "assignee": "hr",
            "offset_days": 0
          }
        ]
      }
    ]
  }
}

Start a checklist for someone in my team#

POST/v1/org/team.start_checklistWrite

Starts a checklist HR lets managers start (template_id from org_team_checklist_templates) for someone in your team (person_id: anyone below you in the reporting line, working now or about to start; never yourself). Due dates hang off anchor_date (YYYY-MM-DD, default today; from 30 days ago to a year ahead). Tasks go to HR, to the person’s manager, to the person or to a named colleague, as the template says; HR sees it on the person’s Checklists and can cancel it. Refused when the same checklist is already running for them. Use dry_run first.

Who can call it
Me key anyone
MCP tool
org_team_start_checklist on My Workplace
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

  • person_idstringrequired

    1–100 characters.

  • template_idstringrequired

    1–100 characters.

  • anchor_datestring

Returns

19 fields
  • idstringrequired
  • namestringrequired
  • kind"onboarding" | "offboarding" | "custom"required
  • template_idstring | nullrequired
  • personobjectrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • anchor_datestring | nullrequired
  • anchor_source"start" | "last_day" | "chosen"required
  • status"open" | "completed" | "cancelled"required
  • started_by"auto" | "manual"required
  • started_atstringrequired
  • completed_atstring | nullrequired
  • cancelled_atstring | nullrequired
  • progressobject | nullrequired
    3 fields
    • doneintegerrequired
    • skippedintegerrequired
    • totalintegerrequired
  • access"full" | "assigned"required
  • can_cancelbooleanrequired
  • shared_with_personbooleanrequired
  • can_sharebooleanrequired
  • waiting_for_toldbooleanrequired
  • tasksobject[]required
    17 fields
    • idstringrequired
    • titlestringrequired
    • descriptionstring | nullrequired
    • link_urlstring | nullrequired
    • assigneeobjectrequired
      2 fields
      • type"hr" | "manager" | "person" | "member"required
      • personobject | nullrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
    • manager_missingbooleanrequired
    • done_when"profile" | "payroll" | "photo" | "invited" | "work_account" | "equipment" | stringrequired
    • offset_daysintegerrequired
    • due_datestringrequired
    • visible_fromstring | nullrequired
    • status"open" | "done" | "skipped"required
    • resolved_atstring | nullrequired
    • resolved_byobject | nullrequired
      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • skip_reasonstring | nullrequired
    • commentsobject[]required
      4 fields
      • idstringrequired
      • authorobject | nullrequired
        4 fields
        • idstringrequired
        • namestringrequired
        • titlestring | nullrequired
        • photo_urlstring | nullrequired
      • textstringrequired
      • atstringrequired
    • canobjectrequired
      4 fields
      • tickbooleanrequired
      • skipbooleanrequired
      • reassignbooleanrequired
      • commentbooleanrequired
    • externalobject | nullrequired
      12 fields
      • toolstring (enum)required

        One of: jira, linear, asana, monday, clickup, microsoft_todo, microsoft_planner, trello, notion, freshservice, zendesk, servicenow, talentlms, learning360, docebo, moodle, linkedin_learning.

      • tool_namestringrequired
      • state"sending" | "scheduled" | "not_connected" | "linked" | "error" | "not_sent"required
      • keystring | nullrequired
      • urlstring | nullrequired
      • status"open" | "done" | "skipped"required
      • status_namestring | nullrequired
      • synced_atstring | nullrequired
      • errorstring | nullrequired
      • warningstring | nullrequired
      • send_onstring | nullrequired
      • wherestringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.start_checklist \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"person_id":"p4","template_id":"t9","anchor_date":"2026-10-12"}'
Response
{
  "data": {
    "id": "r1",
    "name": "Onboarding",
    "kind": "onboarding",
    "template_id": "o1_onboarding",
    "person": {
      "id": "p2",
      "name": "Rui Costa",
      "title": "CTO",
      "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
    },
    "anchor_date": "2026-10-12",
    "anchor_source": "start",
    "status": "open",
    "started_by": "auto",
    "shared_with_person": false,
    "can_share": false,
    "waiting_for_told": false,
    "started_at": "2026-10-04T10:00:00.000Z",
    "completed_at": null,
    "cancelled_at": null,
    "progress": {
      "done": 1,
      "skipped": 0,
      "total": 10
    },
    "access": "full",
    "can_cancel": true,
    "tasks": [
      {
        "id": "t1",
        "title": "Prepare the employment contract",
        "description": "Send it for signature before the first day.",
        "link_url": null,
        "assignee": {
          "type": "manager",
          "person": {
            "id": "p1",
            "name": "Ana Ferreira",
            "title": "CEO",
            "photo_url": null
          }
        },
        "manager_missing": false,
        "done_when": null,
        "offset_days": -10,
        "due_date": "2026-10-10",
        "visible_from": null,
        "status": "done",
        "resolved_at": "2026-10-04T10:00:00.000Z",
        "resolved_by": {
          "id": "p1",
          "name": "Ana Ferreira",
          "title": "CEO",
          "photo_url": null
        },
        "skip_reason": null,
        "comments": [
          {
            "id": "c1",
            "author": {
              "id": "p1",
              "name": "Ana Ferreira",
              "title": "CEO",
              "photo_url": null
            },
            "text": "Sent for signature",
            "at": "2026-10-04T10:00:00.000Z"
          }
        ],
        "can": {
          "tick": true,
          "skip": true,
          "reassign": true,
          "comment": true
        },
        "external": {
          "tool": "jira",
          "tool_name": "Jira",
          "state": "linked",
          "key": "IT-42",
          "url": "https://acme.atlassian.net/browse/IT-42",
          "status": "done",
          "status_name": "Done",
          "synced_at": "2026-10-04T10:00:00.000Z",
          "error": null,
          "warning": null,
          "send_on": null,
          "where": "IT · Task"
        }
      }
    ]
  }
}

Ask HR for a new role or a backfill#

POST/v1/org/team.request_roleWrite

For managers (My workspace): asks HR for a role in your team. kind "new" (title, or title_id from org_titles_search) or "backfill" (replaces_person_id: someone in your line, working now or who left within a year; the title defaults to theirs). Optional: unit_id (default theirs, or your own team), location_id, contract_type, weekly_hours, target_start_date (YYYY-MM-DD, today or later) and note (up to 1,000 characters, for HR: why it is needed). It becomes a draft position reporting to you: HR opens it (approved) or cancels it (declined) in Positions, and you follow it with org_team_role_requests. A title that is not in the catalog yet stays as typed for HR to decide. No budget: HR sets it. At most 20 requests waiting at once. Use dry_run first.

Who can call it
Me key anyone
MCP tool
org_team_request_role on My Workplace
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

  • kind"new" | "backfill"required
  • titlestring

    1–120 characters.

  • title_idstring

    1–100 characters.

  • replaces_person_idstring

    1–100 characters.

  • unit_idstring

    1–100 characters.

  • location_idstring

    1–100 characters.

  • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"
  • weekly_hoursnumber

    From 0 to 80.

  • target_start_datestring
  • notestring

    Up to 1000 characters.

Returns

11 fields
  • idstringrequired

    The draft position id (HR sees it in Positions).

  • kind"new" | "backfill"required
  • titlestringrequired
  • replacesobject | nullrequired

    backfill: the person whose role it fills.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • unitobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
  • weekly_hoursnumber | nullrequired
  • target_start_datestring | nullrequired
  • notestring | nullrequired
  • status"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"required

    waiting (a draft HR has not decided), opened (HR opened the position: it is being filled), on_hold, filled, declined (HR cancelled it), withdrawn (you withdrew it).

  • asked_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.request_role \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "kind": "backfill",
  "replaces_person_id": "p3",
  "target_start_date": "2026-12-01",
  "note": "Rui leaves at the end of November."
}'
Response
{
  "data": {
    "id": "pos3",
    "kind": "backfill",
    "title": "Data Engineer",
    "replaces": {
      "id": "p3",
      "name": "Rui Costa",
      "title": "Data Engineer",
      "photo_url": null
    },
    "unit": {
      "id": "u2",
      "name": "Engineering"
    },
    "contract_type": "permanent",
    "weekly_hours": 40,
    "target_start_date": "2026-12-01",
    "note": "Rui leaves at the end of November.",
    "status": "waiting",
    "asked_at": "2026-10-03T09:00:00.000Z"
  }
}

My requests for roles#

POST/v1/org/team.role_requestsRead

The roles you asked HR for (org_team_request_role), newest first, at most 50: title, new or backfill, the person a backfill replaces, team, target start, your note and where it stands (waiting, opened, on_hold, filled, declined, withdrawn).

Who can call it
Me key anyone
MCP tool
org_team_role_requests on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • requestsobject[]required
    11 fields
    • idstringrequired

      The draft position id (HR sees it in Positions).

    • kind"new" | "backfill"required
    • titlestringrequired
    • replacesobject | nullrequired

      backfill: the person whose role it fills.

      4 fields
      • idstringrequired
      • namestringrequired
      • titlestring | nullrequired
      • photo_urlstring | nullrequired
    • unitobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
    • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
    • weekly_hoursnumber | nullrequired
    • target_start_datestring | nullrequired
    • notestring | nullrequired
    • status"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"required

      waiting (a draft HR has not decided), opened (HR opened the position: it is being filled), on_hold, filled, declined (HR cancelled it), withdrawn (you withdrew it).

    • asked_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.role_requests \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "requests": [
      {
        "id": "pos3",
        "kind": "backfill",
        "title": "Data Engineer",
        "replaces": {
          "id": "p3",
          "name": "Rui Costa",
          "title": "Data Engineer",
          "photo_url": null
        },
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "contract_type": "permanent",
        "weekly_hours": 40,
        "target_start_date": "2026-12-01",
        "note": "Rui leaves at the end of November.",
        "status": "waiting",
        "asked_at": "2026-10-03T09:00:00.000Z"
      },
      {
        "id": "pos4",
        "kind": "new",
        "title": "Product Designer",
        "replaces": null,
        "unit": {
          "id": "u2",
          "name": "Engineering"
        },
        "contract_type": "permanent",
        "weekly_hours": 40,
        "target_start_date": "2026-12-01",
        "note": null,
        "status": "opened",
        "asked_at": "2026-10-03T09:00:00.000Z"
      }
    ]
  }
}

Withdraw a request for a role#

POST/v1/org/team.withdraw_role_requestWrite

Withdraws a role you asked for while HR has not decided it (still waiting): the draft position is cancelled. Once HR opened it, ask HR instead.

Who can call it
Me key anyone
MCP tool
org_team_withdraw_role_request on My Workplace
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • request_idstringrequired

    1–100 characters.

Returns

11 fields
  • idstringrequired

    The draft position id (HR sees it in Positions).

  • kind"new" | "backfill"required
  • titlestringrequired
  • replacesobject | nullrequired

    backfill: the person whose role it fills.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • unitobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"required
  • weekly_hoursnumber | nullrequired
  • target_start_datestring | nullrequired
  • notestring | nullrequired
  • status"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"required

    waiting (a draft HR has not decided), opened (HR opened the position: it is being filled), on_hold, filled, declined (HR cancelled it), withdrawn (you withdrew it).

  • asked_atstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/team.withdraw_role_request \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"request_id":"pos3"}'
Response
{
  "data": {
    "id": "pos3",
    "kind": "backfill",
    "title": "Data Engineer",
    "replaces": {
      "id": "p3",
      "name": "Rui Costa",
      "title": "Data Engineer",
      "photo_url": null
    },
    "unit": {
      "id": "u2",
      "name": "Engineering"
    },
    "contract_type": "permanent",
    "weekly_hours": 40,
    "target_start_date": "2026-12-01",
    "note": "Rui leaves at the end of November.",
    "status": "withdrawn",
    "asked_at": "2026-10-03T09:00:00.000Z"
  }
}

How pay is set#

POST/v1/org/me.pay_infoRead

What you may know about pay at your company (EU Pay Transparency Directive Art. 6 and 7): the pay policy (how pay, pay levels and progression are set; null when the company has not written it), the factors jobs are evaluated on and their weights, whether workers' representatives agreed the criteria, your category of workers (people doing the same work or work of equal value; null when your job is in none), and your own pay band and where your pay sits in it, only when the company shows bands to people (bands_shown). requests says how many requests you made in the last 12 months; there is no limit (org_me_pay_request). For yourself; an API key or AI app acting for you can use it too. Part of the Pay equity module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).

Who can call it
Me key anyone
MCP tool
org_me_pay_info on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

8 fields
  • pay_policystring | nullrequired
  • weightsobjectrequired

    Factor weights in %, adding up to 100.

    5 fields
    • skillsnumberrequired
    • effortnumberrequired
    • responsibilitynumberrequired
    • working_conditionsnumberrequired
    • othernumberrequired
  • representativesobjectrequired
    2 fields
    • existbooleanrequired
    • criteria_agreed_onstring | nullrequired
  • categoryobject | nullrequired
    2 fields
    • idstringrequired
    • namestringrequired
  • bands_shownbooleanrequired
  • bandobject | nullrequired

    Your band today; null when bands are not shown or your job has none.

    6 fields
    • minnumberrequired
    • maxnumberrequired
    • currencystringrequired
    • period"year" | "month" | "hour"required
    • pctnumber | nullrequired

      0 = the minimum, 100 = the maximum (pay converted to the band's period and scaled to full time).

    • status"below" | "in" | "above" | "other_currency" | "other_period"required

      Null without pay recorded.

  • min_groupintegerrequired

    The fewest women and men in a category (not counting you) before averages are given at once.

  • requestsobjectrequired
    1 field
    • usedintegerrequired

      Requests in the last 12 months (there is no limit).

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.pay_info \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "pay_policy": "Pay follows the band of your job; raises each March.",
    "weights": {
      "skills": 25,
      "effort": 25,
      "responsibility": 25,
      "working_conditions": 25,
      "other": 0
    },
    "representatives": {
      "exist": false,
      "criteria_agreed_on": null
    },
    "category": {
      "id": "c1",
      "name": "Engineering"
    },
    "bands_shown": true,
    "band": {
      "min": 40000,
      "max": 50000,
      "currency": "EUR",
      "period": "year",
      "pct": 50,
      "status": "in"
    },
    "min_group": 3,
    "requests": {
      "used": 1
    }
  }
}

Ask about pay levels#

POST/v1/org/me.pay_requestWrite

Asks your company, in writing, for your pay level and the average pay levels of women and men in your category of workers (EU Pay Transparency Directive Art. 7). When you have pay recorded, your job is in a pay category, and at least the company's minimum (min_group, default 3) of women and of men in it besides you are paid in your currency, the answer is given at once (status answered): your gross annual and hourly pay and their averages, on today's pay. Otherwise the request is open: HR answers in writing by due_on (two months, or sooner where your country's law says so) and the reason is in answer.withheld. A repeat request after fewer than that minimum of people joined or left your category since your last answer goes to HR too (answer.withheld recent_change: comparing the answers could reveal their pay). Your manager is not told and no other system is notified; only you and HR see the request. A dry run says whether the answer would come at once (status) but never includes the averages: only the request gives them. There is no limit on how often you ask (Art. 7 sets none): asking again while a request waits for HR, or the same day when nothing changed, returns that request with repeat true and records nothing new. For yourself; an API key or AI app acting for you can use it too. Part of the Pay equity module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).

Who can call it
Me key anyone
MCP tool
org_me_pay_request on My Workplace
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

No input: send {}.

Returns

9 fields
  • idstringrequired
  • created_atstringrequired
  • due_onstringrequired

    The answer is due by this day (two months after the request).

  • status"answered" | "open"required

    answered: the averages were given at once, or HR replied in writing; open: HR still has to reply.

  • answerobjectrequired
    6 fields
    • as_ofstringrequired
    • categoryobject | nullrequired

      Your category of workers: people doing the same work or work of equal value.

      2 fields
      • idstringrequired
      • namestringrequired
    • ownobject | nullrequired

      Your pay level that day: your gross pay in force, annualised (year: as is; month: × 12; hour: × your hours in a year), and per hour (your weekly hours, else FTE × the standard week). Null without pay recorded.

      3 fields
      • annualnumberrequired
      • hourlynumberrequired
      • currencystringrequired
    • womenobject | nullrequired

      Women in your category that day, not counting you, paid in your currency. Null when withheld.

      3 fields
      • countintegerrequired
      • annual_meannumberrequired

        Average gross annual pay (pay in force that day, annualised).

      • hourly_meannumberrequired

        Average gross hourly pay.

    • menobject | nullrequired
      3 fields
      • countintegerrequired
      • annual_meannumberrequired

        Average gross annual pay (pay in force that day, annualised).

      • hourly_meannumberrequired

        Average gross hourly pay.

    • withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"required

      Why the averages were not given at once, so HR answers in writing within two months: small_group (fewer than the company's minimum of women or of men in your category, not counting you: averages could reveal a colleague's pay), recent_change (since your last answer, fewer than that minimum of people joined or left your category: comparing the two answers could reveal their pay), category_review (a job evaluation of your category is being changed, so HR confirms the category first), no_category (your job is in no pay category yet), no_pay (no pay recorded for you). Null: answered.

  • hr_replystring | nullrequired

    HR's written answer.

  • answered_atstring | nullrequired
  • requestsobjectrequired
    1 field
    • usedintegerrequired

      Requests in the last 12 months (there is no limit).

  • repeatbooleanrequired

    True: the same answer as your request of the same id (still with HR, or nothing changed today); nothing new was recorded.

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.pay_request \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Response
{
  "data": {
    "id": "rq1",
    "created_at": "2026-10-04T10:00:00.000Z",
    "due_on": "2026-12-04",
    "status": "answered",
    "answer": {
      "as_of": "2026-10-04",
      "category": {
        "id": "c1",
        "name": "Engineering"
      },
      "own": {
        "annual": 45000,
        "hourly": 21.58,
        "currency": "EUR"
      },
      "women": {
        "count": 3,
        "annual_mean": 40000,
        "hourly_mean": 19.18
      },
      "men": {
        "count": 4,
        "annual_mean": 52000,
        "hourly_mean": 24.93
      },
      "withheld": null
    },
    "hr_reply": null,
    "answered_at": "2026-10-04T10:00:00.000Z",
    "requests": {
      "used": 1
    },
    "repeat": false
  }
}

My pay requests#

POST/v1/org/me.pay_requestsRead

Your requests about pay levels (org_me_pay_request), newest first: the answer given at once, or HR's written reply, and when each is due. requests: how many requests you made in the last 12 months (there is no limit). For yourself; an API key or AI app acting for you can use it too. Part of the Pay equity module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules); this read of stored data keeps working while it is off.

Who can call it
Me key anyone
MCP tool
org_me_pay_requests on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • itemsobject[]required
    7 fields
    • idstringrequired
    • created_atstringrequired
    • due_onstringrequired

      The answer is due by this day (two months after the request).

    • status"answered" | "open"required

      answered: the averages were given at once, or HR replied in writing; open: HR still has to reply.

    • answerobjectrequired
      6 fields
      • as_ofstringrequired
      • categoryobject | nullrequired

        Your category of workers: people doing the same work or work of equal value.

        2 fields
        • idstringrequired
        • namestringrequired
      • ownobject | nullrequired

        Your pay level that day: your gross pay in force, annualised (year: as is; month: × 12; hour: × your hours in a year), and per hour (your weekly hours, else FTE × the standard week). Null without pay recorded.

        3 fields
        • annualnumberrequired
        • hourlynumberrequired
        • currencystringrequired
      • womenobject | nullrequired

        Women in your category that day, not counting you, paid in your currency. Null when withheld.

        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • menobject | nullrequired
        3 fields
        • countintegerrequired
        • annual_meannumberrequired

          Average gross annual pay (pay in force that day, annualised).

        • hourly_meannumberrequired

          Average gross hourly pay.

      • withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"required

        Why the averages were not given at once, so HR answers in writing within two months: small_group (fewer than the company's minimum of women or of men in your category, not counting you: averages could reveal a colleague's pay), recent_change (since your last answer, fewer than that minimum of people joined or left your category: comparing the two answers could reveal their pay), category_review (a job evaluation of your category is being changed, so HR confirms the category first), no_category (your job is in no pay category yet), no_pay (no pay recorded for you). Null: answered.

    • hr_replystring | nullrequired

      HR's written answer.

    • answered_atstring | nullrequired
  • requestsobjectrequired
    1 field
    • usedintegerrequired

      Requests in the last 12 months (there is no limit).

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.pay_requests \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "items": [
      {
        "id": "rq1",
        "created_at": "2026-10-04T10:00:00.000Z",
        "due_on": "2026-12-04",
        "status": "answered",
        "answer": {
          "as_of": "2026-10-04",
          "category": {
            "id": "c1",
            "name": "Engineering"
          },
          "own": {
            "annual": 45000,
            "hourly": 21.58,
            "currency": "EUR"
          },
          "women": {
            "count": 3,
            "annual_mean": 40000,
            "hourly_mean": 19.18
          },
          "men": {
            "count": 4,
            "annual_mean": 52000,
            "hourly_mean": 24.93
          },
          "withheld": null
        },
        "hr_reply": null,
        "answered_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "requests": {
      "used": 1
    }
  }
}

My welcome page#

POST/v1/org/me.welcomeRead

Your welcome as a new hire, from when you can sign in until 14 days after your first day: the company's welcome message, your first day (start_date, days_to_start, location, team, title, manager, buddy), up to 8 teammates (the same manager), your own onboarding tasks due in your first week, and what to bring. shown false otherwise. Yours only.

Who can call it
Me key anyone
MCP tool
org_me_welcome on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

12 fields
  • shownbooleanrequired

    false: not a new hire now (before sign-in, more than 14 days after the first day, or the company turned it off).

  • start_datestring | nullrequired
  • days_to_startinteger | nullrequired
  • messagestring | nullrequired
  • bringstring | nullrequired
  • locationstring | nullrequired
  • teamstring | nullrequired
  • titlestring | nullrequired
  • managerobject | nullrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • buddyobject | nullrequired
    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • teammatesobject[]required

    Up to 8 people with the same manager.

    4 fields
    • idstringrequired
    • namestringrequired
    • titlestring | nullrequired
    • photo_urlstring | nullrequired
  • first_weekobject[]required

    Your own onboarding tasks due in your first week.

    5 fields
    • idstringrequired
    • run_idstringrequired
    • titlestringrequired
    • due_datestringrequired
    • donebooleanrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/me.welcome \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "shown": true,
    "start_date": "2026-10-19",
    "days_to_start": 15,
    "message": "Welcome to Acme! We are glad you are here.",
    "bring": "Your ID card for the building pass.",
    "location": "Head office",
    "team": "Engineering",
    "title": "Engineer",
    "manager": {
      "id": "p2",
      "name": "Rui Costa",
      "title": "CTO",
      "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
    },
    "buddy": {
      "id": "p7",
      "name": "João Pereira",
      "title": "CTO",
      "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
    },
    "teammates": [
      {
        "id": "p2",
        "name": "Rui Costa",
        "title": "CTO",
        "photo_url": "https://acme.bizisy.com/api/photos/people/p2?v=01k0000000000000000000000b"
      }
    ],
    "first_week": [
      {
        "id": "t7",
        "run_id": "run1",
        "title": "Get set up in Bizisy",
        "due_date": "2026-10-19",
        "done": false
      }
    ]
  }
}

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

Developer docs