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_geton My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
37 fields
idstringrequirednamestringrequiredgiven_namestringrequiredfamily_namestringrequiredpreferred_namestring | nullrequiredwork_emailstringrequiredtitlestring | nullrequiredstatus"invited" | "pre_hire" | "active" | "terminated" | "none"requiredinvited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.
start_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
invitedbooleanrequiredhas_loginbooleanrequiredphoto_urlstring | nullrequiredpronounsstring | nullrequiredwork_phonestring | nullrequiredpersonal_emailstring | nullrequiredpersonal_phonestring | nullrequiredaddressobject | nullrequired5 fields
line1stringrequiredline2stringcitystringrequiredpostal_codestringcountrystringrequired
birthdaystring | nullrequiredsex"female" | "male" | "another" | "undisclosed"requiredFor 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[] | nullrequired3 fields
namestringrequiredrelationshipstringrequiredphonestringrequired
tax_idstring | nullrequiredsocial_security_numberstring | nullrequiredibanstring | nullrequiredcustomobject[]required7 fields
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
jobobject | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[] | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
visible_tiers"public" | "private" | "job" | "pay"[]requiredplannedobject | nullrequiredWhile invited (status invited): the job details known so far (job tier; null otherwise or when not visible).
14 fields
titlestring | nullrequiredtitle_idstring | nullrequiredstart_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumber | nullrequiredcontract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequired
missing"given_name" | "family_name" | "title" | "start_date"[]requiredWhile invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.
dotted_managersobject[]requiredDotted-line managers today (spec structure-over-time D10): they see job details, never approve.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
dotted_reportsobject[]requiredPeople this person has a dotted line to today.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
comingobject[]required5 fields
kind"starts" | "probation_ends" | "contract_ends" | "job_change" | "last_day" | "anniversary"requireddatestringrequiredreasonstring | nullrequiredtitlestring | nullrequiredyearsinteger | nullrequired
roleobject | nullrequired2 fields
titlestringrequireddescriptionstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_updateon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
preferred_namestring | null1–100 characters.
pronounsstring | nullUp to 40 characters.
work_phonestring | nullPattern
^\+?[0-9 ().-]{3,40}$.personal_emailany | nullpersonal_phonestring | nullPattern
^\+?[0-9 ().-]{3,40}$.addressobject | null5 fields
line1stringrequired1–200 characters.
line2stringUp to 200 characters.
citystringrequired1–100 characters.
postal_codestringUp to 20 characters.
countryanyrequired
birthdaystring | nullsex"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
namestringrequired1–100 characters.
relationshipstringrequired1–60 characters.
phonestringrequiredPattern
^\+?[0-9 ().-]{3,40}$.
tax_idstring | nullPattern
^[A-Za-z0-9 ./-]{1,40}$.social_security_numberstring | nullPattern
^[A-Za-z0-9 ./-]{1,40}$.ibanany | nullemergency_contacts_addobject[]Contacts to add to the current list (at most 5 in all).
1–5 items.
3 fields
namestringrequired1–100 characters.
relationshipstringrequired1–60 characters.
phonestringrequiredPattern
^\+?[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_mergeobjectAddress 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
line1string1–200 characters.
line2string | nullUp to 200 characters.
citystring1–100 characters.
postal_codestring | nullUp to 20 characters.
countryany
Returns
35 fields
idstringrequirednamestringrequiredgiven_namestringrequiredfamily_namestringrequiredpreferred_namestring | nullrequiredwork_emailstringrequiredtitlestring | nullrequiredstatus"invited" | "pre_hire" | "active" | "terminated" | "none"requiredinvited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.
start_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
invitedbooleanrequiredhas_loginbooleanrequiredphoto_urlstring | nullrequiredpronounsstring | nullrequiredwork_phonestring | nullrequiredpersonal_emailstring | nullrequiredpersonal_phonestring | nullrequiredaddressobject | nullrequired5 fields
line1stringrequiredline2stringcitystringrequiredpostal_codestringcountrystringrequired
birthdaystring | nullrequiredsex"female" | "male" | "another" | "undisclosed"requiredFor 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[] | nullrequired3 fields
namestringrequiredrelationshipstringrequiredphonestringrequired
tax_idstring | nullrequiredsocial_security_numberstring | nullrequiredibanstring | nullrequiredcustomobject[]required7 fields
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
jobobject | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[] | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
visible_tiers"public" | "private" | "job" | "pay"[]requiredplannedobject | nullrequiredWhile invited (status invited): the job details known so far (job tier; null otherwise or when not visible).
14 fields
titlestring | nullrequiredtitle_idstring | nullrequiredstart_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumber | nullrequiredcontract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequired
missing"given_name" | "family_name" | "title" | "start_date"[]requiredWhile invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.
dotted_managersobject[]requiredDotted-line managers today (spec structure-over-time D10): they see job details, never approve.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
dotted_reportsobject[]requiredPeople this person has a dotted line to today.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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"
}
]
}'const res = await fetch('https://api.bizisy.com/v1/org/me.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"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"
}
]
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"preferred_name": None,
"pronouns": "she/her",
"work_phone": "+351 912",
"personal_email": None,
"personal_phone": None,
"birthday": None,
"sex": "undisclosed",
"address": {
"line1": "Rua Augusta 100",
"city": "Lisboa",
"country": "PT",
},
"emergency_contacts": [
{
"name": "Rui",
"relationship": "Partner",
"phone": "+351 911",
},
],
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_teamon My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
peersobject[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
reportsobject[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
dotted_reportsobject[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
summaryobject | nullrequired9 fields
team_sizeintegerrequiredchange_since_janintegerrequiredreportsobject[]required2 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
people_underintegerrequired
probationobject[]required2 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
datestringrequired
contract_endsobject[]required2 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
datestringrequired
checklistsobject[]required6 fields
idstringrequirednamestringrequiredkind"onboarding" | "offboarding" | "custom"requiredpersonobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
anchor_datestringrequiredprogressobjectrequired3 fields
doneintegerrequiredskippedintegerrequiredtotalintegerrequired
to_tellobject[]required3 fields
personobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
datestringrequiredlast_daystringrequired
approvals_waitingintegerrequiredcomingobject[]required5 fields
kind"starts" | "last_day" | "probation_ends" | "contract_ends" | "job_change"requireddatestringrequiredpersonobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
reasonstring | nullrequiredtitlestring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.team \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.team', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.team",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_titleon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
display_titlestring | nullrequired1–120 characters.
Returns
approvalobject | nullrequired11 fields
idstringrequiredstatus"pending" | "approved"requiredwaiting_for"manager" | "hr"requiredapproversstring[]requiredautomaticbooleanrequirednote"proposed_by_approver" | "no_other_approver"requiredfallbackbooleanrequiredteam_leadobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredreason"no_manager" | "manager_left"required
team_lead_blockedobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredwhat"lead" | "removed" | "moved" | "archived"required
untrusted"no_login" | "invited_by_proposer"requiredthen"manager" | "hr"required
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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"}'const res = await fetch('https://api.bizisy.com/v1/org/me.request_profile_title', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"display_title": "Backend Wizard"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.request_profile_title",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"display_title": "Backend Wizard",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_detailson My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
given_namestring1–100 characters.
family_namestring1–100 characters.
titlestring1–120 characters.
start_datestringnotestringUp to 500 characters.
Returns
personobjectrequired35 fields
idstringrequirednamestringrequiredgiven_namestringrequiredfamily_namestringrequiredpreferred_namestring | nullrequiredwork_emailstringrequiredtitlestring | nullrequiredstatus"invited" | "pre_hire" | "active" | "terminated" | "none"requiredinvited: waiting for their details (names, title, start date), not employed yet; pre_hire: starts later; active; terminated: has left; none: no job.
start_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
invitedbooleanrequiredhas_loginbooleanrequiredphoto_urlstring | nullrequiredpronounsstring | nullrequiredwork_phonestring | nullrequiredpersonal_emailstring | nullrequiredpersonal_phonestring | nullrequiredaddressobject | nullrequired5 fields
line1stringrequiredline2stringcitystringrequiredpostal_codestringcountrystringrequired
birthdaystring | nullrequiredsex"female" | "male" | "another" | "undisclosed"requiredFor 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[] | nullrequired3 fields
namestringrequiredrelationshipstringrequiredphonestringrequired
tax_idstring | nullrequiredsocial_security_numberstring | nullrequiredibanstring | nullrequiredcustomobject[]required7 fields
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
jobobject | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[] | nullrequired23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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[]required4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
visible_tiers"public" | "private" | "job" | "pay"[]requiredplannedobject | nullrequiredWhile invited (status invited): the job details known so far (job tier; null otherwise or when not visible).
14 fields
titlestring | nullrequiredtitle_idstring | nullrequiredstart_datestring | nullrequiredunitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumber | nullrequiredcontract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequired
missing"given_name" | "family_name" | "title" | "start_date"[]requiredWhile invited: what is still needed to register them (given_name, family_name, title, start_date); [] otherwise.
dotted_managersobject[]requiredDotted-line managers today (spec structure-over-time D10): they see job details, never approve.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
dotted_reportsobject[]requiredPeople this person has a dotted line to today.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
registeredbooleanrequiredTrue when this call registered them (their first job row was written).
missing"given_name" | "family_name" | "title" | "start_date"[]requiredWhat is still needed to register them; [] once registered.
approvalobject | nullrequiredYour suggested title and start date, waiting for HR.
11 fields
idstringrequiredstatus"pending" | "approved"requiredwaiting_for"manager" | "hr"requiredapproversstring[]requiredautomaticbooleanrequirednote"proposed_by_approver" | "no_other_approver"requiredfallbackbooleanrequiredteam_leadobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredreason"no_manager" | "manager_left"required
team_lead_blockedobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredwhat"lead" | "removed" | "moved" | "archived"required
untrusted"no_login" | "invited_by_proposer"requiredthen"manager" | "hr"required
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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."
}'const res = await fetch('https://api.bizisy.com/v1/org/me.set_details', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"given_name": "Rita",
"family_name": "Sousa",
"title": "Designer",
"start_date": "2026-11-02",
"note": "As agreed with Rui."
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.set_details",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"given_name": "Rita",
"family_name": "Sousa",
"title": "Designer",
"start_date": "2026-11-02",
"note": "As agreed with Rui.",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_joiningon My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
An array of objects with 7 fields
An array of objects:
idstringrequirednamestringrequiredwork_emailstringrequiredtitlestring | nullrequiredstart_datestring | nullrequiredmissing"given_name" | "family_name" | "title" | "start_date"[]requiredwaitingbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/team.joining \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/team.joining', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.joining",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": [
{
"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_detailson My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
person_idstringrequiredtitlestring1–120 characters.
start_datestringunit_idstringnotestringUp to 500 characters.
Returns
approvalobjectrequired11 fields
idstringrequiredstatus"pending" | "approved"requiredwaiting_for"manager" | "hr"requiredapproversstring[]requiredautomaticbooleanrequirednote"proposed_by_approver" | "no_other_approver"requiredfallbackbooleanrequiredteam_leadobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredreason"no_manager" | "manager_left"required
team_lead_blockedobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredwhat"lead" | "removed" | "moved" | "archived"required
untrusted"no_login" | "invited_by_proposer"requiredthen"manager" | "hr"required
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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."
}'const res = await fetch('https://api.bizisy.com/v1/org/team.suggest_details', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"person_id": "p9",
"title": "Designer",
"start_date": "2026-11-02",
"unit_id": "u2",
"note": "Joins the design team."
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.suggest_details",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"person_id": "p9",
"title": "Designer",
"start_date": "2026-11-02",
"unit_id": "u2",
"note": "Joins the design team.",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_dataon My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
61 fields
format"bizisy.person-data.v1"requiredgenerated_atstringrequiredorganization_idstringrequiredpersonobjectrequiredphotoobject | nullrequired3 fields
content_typestringrequireddata_base64stringrequiredupdated_atstringrequired
jobsobject[]required23 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredtitlestringrequiredThe job title as the catalog names it now (reports and grouping use this).
title_idstring | nullrequiredThe catalog title (
org_titles_list); null while not in the catalog yet.display_titlestring | nullrequiredA different title shown on the profile, chart and directory; null: the catalog title.
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
managerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
locationobject | nullrequired2 fields
idstringrequirednamestringrequired
legal_entityobject | nullrequired2 fields
idstringrequirednamestringrequired
employment_type"full_time" | "part_time" | "contractor" | "intern"requiredftenumberrequiredreasonstringrequiredend_reasonstring | nullrequiredleaving_typestring (enum)requiredWhy the employment ended (structured); null: not recorded or still employed.
One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.toldboolean | nullrequiredWith 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_toldor the day passes. null on other rows.contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredcontract_end_datestring | nullrequiredprobation_end_datestring | nullrequiredweekly_hoursnumber | nullrequirednotice_period_daysinteger | nullrequiredcustomobject[]requiredJob 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
keystringrequiredlabelstringrequiredtypestring (enum)requiredOne of:
text,number,date,select,boolean,file,person,table.tier"public" | "job" | "private"requiredvaluestring | number | boolean | object[]requiredFor type file: the document id (download it with
documents_downloadordocuments_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 inorg_fields_list).fileobject | nullType file only: the file, or null when none is attached.
4 fields
namestring | nullrequiredThe file name; null over an API key or MCP for someone else's file.
sizeintegerrequiredcontent_typestringrequiredpreviewablebooleanrequiredThe web app can show it (PDF, PNG, JPEG, WebP).
personobject | nullType person only: who it names (null when not set, or not someone you may see).
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
regrettedboolean | nullPrivate (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 | nullA 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_daystringrequiredleaving_typestring (enum)requiredOne of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.reasonstring | nullrequiredtoldbooleanrequiredfalse: not told yet (HR's export only: their own copy leaves it out until they are told).
recorded_atstringrequired
payobject[]required8 fields
idstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequiredamountnumberrequiredcurrencystringrequiredperiod"year" | "month" | "hour"requirednotestring | nullrequiredcreated_atstringrequired
invitesobject[]required6 fields
emailstringrequiredrolestringrequiredcreated_atstringrequiredexpires_atstringrequiredaccepted_atstring | nullrequiredrevoked_atstring | nullrequired
loginsobject[]requiredapi_keysobject[]requiredconnected_appsobject[]requireddpa_acceptancesobject[]activityobject[]requiredactivity_truncatedbooleanrequiredchange_historyobject[]required8 fields
idstringrequiredentry_idstringrequiredatstringrequiredop"insert" | "update" | "delete"requiredrecordobjectrequired4 fields
kindstringrequiredidstringrequirednamestring | nullrequireddatestring | nullrequired
person_idsstring[]requiredfieldsobject[]required6 fields
keystringrequiredlabelstring | nullrequiredtier"public" | "job" | "private" | "pay" | "hr"requiredbeforeobjectrequired27 fields (one of several shapes)
Option 1
t"text"requiredvstringrequired
Option 2
t"number"requiredvnumberrequired
Option 3
t"bool"requiredvbooleanrequired
Option 4
t"date"requiredvstringrequired
Option 5
t"datetime"requiredvstringrequired
Option 6
t"money"requiredamountnumberrequiredcurrencystringrequiredperiodstring | nullrequired
Option 7
t"ref"requiredkindstring (enum)requiredOne of:
person,unit,location,title,entity,position,family,level,category,field,document,checklist.idstringrequirednamestring | nullrequired
Option 8
t"enum"requiredsetstringrequiredvstringrequired
Option 9
t"list"requireditemsany[]required
Option 10
t"file"requirednamestring | nullrequiredsizenumber | nullrequired
Option 11
t"secret"required
afterobjectrequired27 fields (one of several shapes)
Option 1
t"text"requiredvstringrequired
Option 2
t"number"requiredvnumberrequired
Option 3
t"bool"requiredvbooleanrequired
Option 4
t"date"requiredvstringrequired
Option 5
t"datetime"requiredvstringrequired
Option 6
t"money"requiredamountnumberrequiredcurrencystringrequiredperiodstring | nullrequired
Option 7
t"ref"requiredkindstring (enum)requiredOne of:
person,unit,location,title,entity,position,family,level,category,field,document,checklist.idstringrequirednamestring | nullrequired
Option 8
t"enum"requiredsetstringrequiredvstringrequired
Option 9
t"list"requireditemsany[]required
Option 10
t"file"requirednamestring | nullrequiredsizenumber | nullrequired
Option 11
t"secret"required
hiddenbooleanrequired
truncatedbooleanrequired
change_history_truncatedbooleanrequirednotificationsobject[]required3 fields
typestringrequiredcreated_atstringrequiredread_atstring | nullrequired
home_preferencesobject[]required4 fields
managestring | nullrequiredmestring | nullrequiredpinsobjectrequired2 fields
managestring[]requiredmestring[]required
updated_atstringrequired
directory_accountsobject[]required3 fields
providerstringrequiredaccountstring | nullrequiredexcludedbooleanrequired
spend_accountsobject[]requiredTheir account in each connected spend tool (Pleo, Moss, Payhawk, Spendesk) as Bizisy last read it.
4 fields
toolstringrequiredaccountstring | nullrequiredstatestring | nullrequiredexcludedbooleanrequired
recruitingobject[]requiredThe recruiting tool application they were hired from (Teamtailor, Greenhouse).
3 fields
toolstringrequiredapplication_idstringrequiredreceived_atstringrequired
announcementsobject[]required5 fields
toolstringrequiredkindstringrequireddaystringrequiredstatusstringrequiredposted_atstring | nullrequired
remindersobject[]required3 fields
kindstringrequireddatestringrequiredsent_atstringrequired
occupational_health_checkobject | nullrequiredThe dates HR keeps (never a result).
2 fields
last_onstring | nullrequirednext_due_set_by_hrstring | nullrequired
check_insobjectrequired6 fields
one_on_onesobject[]required7 fields
role"person" | "manager"requiredkindstringrequiredwithstringrequiredcadencestringrequiredfirst_datestringrequiredlast_heldstring | nullrequiredendedbooleanrequired
meetingsobject[]required3 fields
role"person" | "manager"requireddatestringrequiredstatusstringrequired
pointsobject[]required9 fields
role"person" | "manager"requiredkindstringrequiredtextstringrequiredbystringrequiredownerstring | nullrequiredduestring | nullrequireddone_onstring | nullrequiredheld_onstring | nullrequirednotesstring | nullrequired
notesobject[]required4 fields
datestringrequiredtextstringrequiredwritten_by"them" | "the other side"requiredratingstring | nullrequired
quarterlyobject[]required3 fields
periodstringrequiredselfobject | nullrequired3 fields
answersobject[]required3 fields
question_idstringrequiredquestionstringrequiredtextstringrequired
ratinginteger | nullrequiredsubmitted_atstring | nullrequired
managerobject | nullrequired3 fields
answersobject[]required3 fields
question_idstringrequiredquestionstringrequiredtextstringrequired
ratinginteger | nullrequiredsubmitted_atstring | nullrequired
exemptionsobject[]required4 fields
statusstringrequiredjustificationstringrequireduntilstring | nullrequiredcreated_atstringrequired
company_announcementsobjectrequiredAnnouncements published to the person (with when they saw and acknowledged each) and those they posted.
2 fields
receivedobject[]required7 fields
titlestringrequiredpublished_atstring | nullrequiredrequires_ackbooleanrequiredseen_atstring | nullrequiredacknowledged_atstring | nullrequiredvia"app" | "kiosk"requiredfingerprintstring | nullrequired
postedobject[]required4 fields
titlestringrequiredstatusstringrequiredcreated_atstringrequiredpublished_atstring | nullrequired
positionsobject[]required4 fields
idstringrequiredtitlestringrequiredstatusstringrequiredrole"filled" | "replaced"required
role_requestsobject[]required5 fields
titlestringrequiredkind"new" | "backfill"requiredstatusstringrequirednotestring | nullrequiredasked_atstringrequired
dotted_linesobject[]required6 fields
role"person" | "manager"requiredpersonstringrequiredmanagerstringrequiredvalid_fromstringrequiredvalid_tostring | nullrequirednotestring | nullrequired
approvalsobject[]requiredsaved_draftsobject[]required4 fields
processstringrequiredlabelstringrequireddataobjectrequiredsaved_atstringrequired
groupsobject[]requiredSaved groups whose criteria name the person (wave H D19: the reports of this manager). Membership is computed when used, never stored.
2 fields
namestringrequirednamed_as"manager"required
import_rowsobject[]requiredRows of import runs (kept 30 days) that name the person: HR's export only.
6 fields
import_idstringrequiredrownumberrequiredoutcomestringrequiredappliedbooleanrequiredcellsstring[] | nullrequirederrorsobject[]required2 fields
columnstring | nullrequiredmessagestringrequired
start_groupsobject[]Start groups the person is in (HR's export).
2 fields
namestringrequiredstart_datestringrequired
move_batchesobject[]Batches of job changes that include the person (HR's export; their own once the change is announced).
5 fields
batchstringrequiredeffective_datestringrequiredannounce_onstringrequiredoutcomestringrequiredproblemstring | nullrequired
movesobject[]Rows of moves from another HR tool (kept 30 days) about the person: HR's export only.
6 fields
run_idstringrequiredkindstringrequiredoutcomestringrequiredappliedbooleanrequiredproblemsstring[]requiredexpires_atstringrequired
checklistsobjectrequired5 fields
about_youobject[]required6 fields
namestringrequiredkindstringrequiredstatusstringrequiredanchor_datestringrequiredstarted_atstringrequiredtasksobject[]required6 fields
titlestringrequireddue_datestringrequiredstatusstringrequiredskip_reasonstring | nullrequiredresolved_atstring | nullrequiredcommentsobject[]required3 fields
textstringrequiredatstringrequiredby_youbooleanrequired
assigned_to_youobject[]required5 fields
checkliststringrequiredtitlestringrequireddue_datestringrequiredstatusstringrequiredresolved_atstring | nullrequired
your_commentsobject[]required4 fields
checkliststringrequiredtaskstringrequiredtextstringrequiredatstringrequired
resolved_by_youobject[]required5 fields
checkliststringrequiredtaskstringrequiredstatusstringrequiredskip_reasonstring | nullrequiredresolved_atstring | nullrequired
template_tasksobject[]required2 fields
templatestringrequiredtaskstringrequired
webhook_deliveriesobject[]required4 fields
event_typestringrequiredendpoint_hoststringrequiredcreated_atstringrequiredstatusstringrequired
integration_linksobject[]required5 fields
toolstringrequiredentitystringrequiredexternal_idstringrequiredexternal_urlstring | nullrequiredlinked_atstringrequired
countryobject | nullrequired3 fields
noticesobject[]required6 fields
obligationstringrequiredevent_datestringrequiredstatusstringrequiredchannelstring | nullrequiredreferencestring | nullrequiredsent_onstring | nullrequired
country_dataobjectrequiredvacation_mapsobject[]4 fields
yearintegerrequiredversionintegerrequiredposted_onstringrequiredperiodsobject[]required3 fields
startstringrequiredendstringrequireddaysnumberrequired
pay_report_inputsobject[]required6 fields
yearinteger | nullrequiredlegal_entitystring | nullrequiredcurrencystring | nullrequiredbonusnumberrequiredallowancesnumberrequiredin_kindnumberrequired
bank_changesobject[]required7 fields
new_ibanstringrequiredstatusstringrequiredrequested_as"self" | "hr"requiredcreated_atstringrequiredproofobject | nullrequired3 fields
content_typestringrequiredsizenumberrequireduploaded_atstringrequired
verdictobject | nullrequired3 fields
resultstringrequiredreasonsstring[]requiredchecked_atstringrequired
decidedobject | nullrequired3 fields
how"automatic" | "hr"requiredatstringrequirednotestring | nullrequired
pay_requestsobject[]required9 fields
idstringrequiredcreated_atstringrequireddue_onstringrequiredstatus"answered" | "open"requiredanswerobjectrequired6 fields
as_ofstringrequiredcategoryobject | nullrequiredYour category of workers: people doing the same work or work of equal value.
2 fields
idstringrequirednamestringrequired
ownobject | nullrequiredYour 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
annualnumberrequiredhourlynumberrequiredcurrencystringrequired
womenobject | nullrequiredWomen in your category that day, not counting you, paid in your currency. Null when withheld.
3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
menobject | nullrequired3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"requiredWhy 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 | nullrequiredanswered_atstring | nullrequiredrecorded_by_hrbooleanreceivedstring | null
field_referencesobject[]required3 fields
fieldstringrequiredtarget"person" | "job" | "unit" | "position"requiredrecordstringrequired
documentsobject[]requireddocument_filesobject[]required2 fields
namestringrequiredurlstringrequired
payrollobjectequipmentobject[]required8 fields
typestringrequirednamestringrequiredmodelstring | nullrequiredserialstring | nullrequiredfromstringrequiredtostring | nullrequiredconfirmed_atstring | nullrequiredreturnedobject | nullrequired2 fields
conditionstringrequirednotestring | nullrequired
time_offobjecttime_clockobjecthiringobjecttrainingobjecttalentobjectcompobjectinsightsobjectshiftsobjectbenefitsobjectsurveysobjectassistantobjectfilenamestringrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.export_data \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.export_data', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.export_data",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_uploadon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
- Body limit
- 3 MiB (other actions: 2 MiB)
Input
image_base64stringrequiredThe 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_idstringrequiredphoto_urlstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict payload_too_large rate_limited internal
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=="}'const res = await fetch('https://api.bizisy.com/v1/org/me.photo.upload', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"image_base64": "UklGRg=="
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.photo.upload",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"image_base64": "UklGRg==",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_removeon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
No input: send {}.
Returns
person_idstringrequiredphoto_urlstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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 '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.photo.remove', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.photo.remove",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_templateson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
templatesobject[]required3 fields
idstringrequirednamestringrequiredtasksobject[]required3 fields
titlestringrequiredassignee"hr" | "manager" | "person" | "member"requiredoffset_daysintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/team.checklist_templates \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/team.checklist_templates', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.checklist_templates",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_checkliston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
person_idstringrequired1–100 characters.
template_idstringrequired1–100 characters.
anchor_datestring
Returns
19 fields
idstringrequirednamestringrequiredkind"onboarding" | "offboarding" | "custom"requiredtemplate_idstring | nullrequiredpersonobjectrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
anchor_datestring | nullrequiredanchor_source"start" | "last_day" | "chosen"requiredstatus"open" | "completed" | "cancelled"requiredstarted_by"auto" | "manual"requiredstarted_atstringrequiredcompleted_atstring | nullrequiredcancelled_atstring | nullrequiredprogressobject | nullrequired3 fields
doneintegerrequiredskippedintegerrequiredtotalintegerrequired
access"full" | "assigned"requiredcan_cancelbooleanrequiredshared_with_personbooleanrequiredcan_sharebooleanrequiredwaiting_for_toldbooleanrequiredtasksobject[]required17 fields
idstringrequiredtitlestringrequireddescriptionstring | nullrequiredlink_urlstring | nullrequiredassigneeobjectrequired2 fields
type"hr" | "manager" | "person" | "member"requiredpersonobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
manager_missingbooleanrequireddone_when"profile" | "payroll" | "photo" | "invited" | "work_account" | "equipment" | stringrequiredoffset_daysintegerrequireddue_datestringrequiredvisible_fromstring | nullrequiredstatus"open" | "done" | "skipped"requiredresolved_atstring | nullrequiredresolved_byobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
skip_reasonstring | nullrequiredcommentsobject[]required4 fields
idstringrequiredauthorobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
textstringrequiredatstringrequired
canobjectrequired4 fields
tickbooleanrequiredskipbooleanrequiredreassignbooleanrequiredcommentbooleanrequired
externalobject | nullrequired12 fields
toolstring (enum)requiredOne of:
jira,linear,asana,monday,clickup,microsoft_todo,microsoft_planner,trello,notion,freshservice,zendesk,servicenow,talentlms,learning360,docebo,moodle,linkedin_learning.tool_namestringrequiredstate"sending" | "scheduled" | "not_connected" | "linked" | "error" | "not_sent"requiredkeystring | nullrequiredurlstring | nullrequiredstatus"open" | "done" | "skipped"requiredstatus_namestring | nullrequiredsynced_atstring | nullrequirederrorstring | nullrequiredwarningstring | nullrequiredsend_onstring | nullrequiredwherestringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
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"}'const res = await fetch('https://api.bizisy.com/v1/org/team.start_checklist', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"person_id": "p4",
"template_id": "t9",
"anchor_date": "2026-10-12"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.start_checklist",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"person_id": "p4",
"template_id": "t9",
"anchor_date": "2026-10-12",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_roleon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
kind"new" | "backfill"requiredtitlestring1–120 characters.
title_idstring1–100 characters.
replaces_person_idstring1–100 characters.
unit_idstring1–100 characters.
location_idstring1–100 characters.
contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"weekly_hoursnumberFrom 0 to 80.
target_start_datestringnotestringUp to 1000 characters.
Returns
11 fields
idstringrequiredThe draft position id (HR sees it in Positions).
kind"new" | "backfill"requiredtitlestringrequiredreplacesobject | nullrequiredbackfill: the person whose role it fills.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredweekly_hoursnumber | nullrequiredtarget_start_datestring | nullrequirednotestring | nullrequiredstatus"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"requiredwaiting (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 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."
}'const res = await fetch('https://api.bizisy.com/v1/org/team.request_role', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"kind": "backfill",
"replaces_person_id": "p3",
"target_start_date": "2026-12-01",
"note": "Rui leaves at the end of November."
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.request_role",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"kind": "backfill",
"replaces_person_id": "p3",
"target_start_date": "2026-12-01",
"note": "Rui leaves at the end of November.",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_requestson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
requestsobject[]required11 fields
idstringrequiredThe draft position id (HR sees it in Positions).
kind"new" | "backfill"requiredtitlestringrequiredreplacesobject | nullrequiredbackfill: the person whose role it fills.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredweekly_hoursnumber | nullrequiredtarget_start_datestring | nullrequirednotestring | nullrequiredstatus"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"requiredwaiting (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 https://api.bizisy.com/v1/org/team.role_requests \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/team.role_requests', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.role_requests",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_requeston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
request_idstringrequired1–100 characters.
Returns
11 fields
idstringrequiredThe draft position id (HR sees it in Positions).
kind"new" | "backfill"requiredtitlestringrequiredreplacesobject | nullrequiredbackfill: the person whose role it fills.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
unitobject | nullrequired2 fields
idstringrequirednamestringrequired
contract_type"permanent" | "fixed_term" | "temporary" | "internship" | "freelance"requiredweekly_hoursnumber | nullrequiredtarget_start_datestring | nullrequirednotestring | nullrequiredstatus"waiting" | "opened" | "on_hold" | "filled" | "declined" | "withdrawn"requiredwaiting (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 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"}'const res = await fetch('https://api.bizisy.com/v1/org/team.withdraw_role_request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"request_id": "pos3"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/team.withdraw_role_request",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"request_id": "pos3",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_infoon My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
8 fields
pay_policystring | nullrequiredweightsobjectrequiredFactor weights in %, adding up to 100.
5 fields
skillsnumberrequiredeffortnumberrequiredresponsibilitynumberrequiredworking_conditionsnumberrequiredothernumberrequired
representativesobjectrequired2 fields
existbooleanrequiredcriteria_agreed_onstring | nullrequired
categoryobject | nullrequired2 fields
idstringrequirednamestringrequired
bands_shownbooleanrequiredbandobject | nullrequiredYour band today; null when bands are not shown or your job has none.
6 fields
minnumberrequiredmaxnumberrequiredcurrencystringrequiredperiod"year" | "month" | "hour"requiredpctnumber | nullrequired0 = 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"requiredNull without pay recorded.
min_groupintegerrequiredThe fewest women and men in a category (not counting you) before averages are given at once.
requestsobjectrequired1 field
usedintegerrequiredRequests in the last 12 months (there is no limit).
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.pay_info \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.pay_info', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.pay_info",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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_requeston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
No input: send {}.
Returns
9 fields
idstringrequiredcreated_atstringrequireddue_onstringrequiredThe answer is due by this day (two months after the request).
status"answered" | "open"requiredanswered: the averages were given at once, or HR replied in writing; open: HR still has to reply.
answerobjectrequired6 fields
as_ofstringrequiredcategoryobject | nullrequiredYour category of workers: people doing the same work or work of equal value.
2 fields
idstringrequirednamestringrequired
ownobject | nullrequiredYour 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
annualnumberrequiredhourlynumberrequiredcurrencystringrequired
womenobject | nullrequiredWomen in your category that day, not counting you, paid in your currency. Null when withheld.
3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
menobject | nullrequired3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"requiredWhy 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 | nullrequiredHR's written answer.
answered_atstring | nullrequiredrequestsobjectrequired1 field
usedintegerrequiredRequests in the last 12 months (there is no limit).
repeatbooleanrequiredTrue: 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 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 '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.pay_request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.pay_request",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"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_requestson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
itemsobject[]required7 fields
idstringrequiredcreated_atstringrequireddue_onstringrequiredThe answer is due by this day (two months after the request).
status"answered" | "open"requiredanswered: the averages were given at once, or HR replied in writing; open: HR still has to reply.
answerobjectrequired6 fields
as_ofstringrequiredcategoryobject | nullrequiredYour category of workers: people doing the same work or work of equal value.
2 fields
idstringrequirednamestringrequired
ownobject | nullrequiredYour 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
annualnumberrequiredhourlynumberrequiredcurrencystringrequired
womenobject | nullrequiredWomen in your category that day, not counting you, paid in your currency. Null when withheld.
3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
menobject | nullrequired3 fields
countintegerrequiredannual_meannumberrequiredAverage gross annual pay (pay in force that day, annualised).
hourly_meannumberrequiredAverage gross hourly pay.
withheld"small_group" | "recent_change" | "category_review" | "no_category" | "no_pay"requiredWhy 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 | nullrequiredHR's written answer.
answered_atstring | nullrequired
requestsobjectrequired1 field
usedintegerrequiredRequests in the last 12 months (there is no limit).
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.pay_requests \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.pay_requests', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.pay_requests",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "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_welcomeon My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
12 fields
shownbooleanrequiredfalse: not a new hire now (before sign-in, more than 14 days after the first day, or the company turned it off).
start_datestring | nullrequireddays_to_startinteger | nullrequiredmessagestring | nullrequiredbringstring | nullrequiredlocationstring | nullrequiredteamstring | nullrequiredtitlestring | nullrequiredmanagerobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
buddyobject | nullrequired4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
teammatesobject[]requiredUp to 8 people with the same manager.
4 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredphoto_urlstring | nullrequired
first_weekobject[]requiredYour own onboarding tasks due in your first week.
5 fields
idstringrequiredrun_idstringrequiredtitlestringrequireddue_datestringrequireddonebooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/me.welcome \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/me.welcome', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/me.welcome",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"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.