API reference
Account and API keys
Who you are, your API keys, your connected apps and your language.
11 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
My companies#
POST/v1/platform/me.companiesRead
The companies you belong to with this account (yours and outside access, such as an accountant's clients): name, address, your role there and whether it reaches Payroll. Each company is opened and signed in to on its own address. An API key or AI app is bound to one company: it gets only this one (security review: a connection to one client must not learn the others).
- Who can call it
- Manage key any Manage role
Me key anyone - Keys and apps
- Only the company the key or app belongs to.
- MCP tool
platform_me_companieson HR Assistant, My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
companiesobject[]required10 fields
org_idstringrequirednamestringrequiredslugstringrequiredurlstringrequiredThe company's Bizisy address (each company signs in on its own).
rolestringrequiredowner, admin, hr, viewer, member, or the custom role's name.
externalbooleanrequiredOutside access (an accountant, a payroll bureau).
access_untilstring | nullrequiredpayrollbooleanrequiredThe role reaches Payroll there (owners, admins, HR, or a custom role with Payroll).
entitiesstring[] | nullrequiredA custom role limited to some legal entities: their ids; null for all.
currentbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/me.companies \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/me.companies', {
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/platform/me.companies",
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": {
"companies": [
{
"org_id": "o1",
"name": "Acme Lda",
"slug": "acme",
"url": "https://acme.bizisy.com",
"role": "Accountant",
"external": true,
"access_until": "2027-03-31T23:00:00.000Z",
"payroll": true,
"entities": null,
"current": true
}
]
}
}Who am I#
POST/v1/platform/whoamiRead
Call this first to orient yourself. Returns the signed-in user, their organization, roles and the audiences (me/manage) they can use; today and time_zone (the company's date: resolve "next Monday" or "end of the month" from it, never from your own clock); me (your own name, title and manager today; null when your login has no person record); approvals (who must approve job changes, terminations and pay changes: off, hr, manager or manager_then_hr; anything but off means a change becomes a request); app_only (what only a person signed in to Bizisy can do, with where and a link: tell the user to do those there, never look for a tool); whether Bizisy billing exists yet (billing). user.language is the language the person chose (null: they follow the company), org.language the company default (null: each browser's language).
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_whoamion My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
27 fields
userobjectrequired4 fields
idstringrequiredemailstringrequireddisplay_namestringrequiredlanguagestring | nullrequired
orgobjectrequired5 fields
idstringrequiredslugstringrequirednamestringrequiredlanguagestring | nullrequiredsandboxbooleanrequiredA developer sandbox: never billed, at most 25 people.
rolesstring[]requiredaudiences"me" | "manage"[]requiredperson_idstring | nullrequiredlimitedbooleanrequiredInvited by email and not registered yet: this login sees only its own record and Get set up (no directory, org chart or company documents) until HR registers the person.
todaystring | nullrequiredThe company's date today (YYYY-MM-DD, in time_zone).
time_zonestring | nullrequiredmeobject | nullrequired3 fields
namestringrequiredtitlestring | nullrequiredmanagerobject | nullrequired2 fields
idstringrequirednamestringrequired
approvalsobject | nullrequired3 fields
job_changestringrequiredterminationstringrequiredpay_changestringrequired
app_onlyobject[]requiredActions only a person signed in to Bizisy can do: no tool or API call does them.
4 fields
toolstringrequiredtitlestringrequiredwherestringrequiredurlstringrequired
billingbooleanrequiredBilling exists (Settings → Plan & billing,
platform_billing_* tools); false while billing has not started for anyone, with nothing to set up.documentsbooleanrequiredDocuments is usable: the server has file storage and the company has Documents on (documents_* tools).
filesbooleanrequiredFile storage exists on this server (
platform_storage_* tools, file fields on profiles), whatever the Documents switch.equipmentbooleanrequiredEquipment is on for the company (assets_* tools).
renewalsbooleanrequiredRenewals is on for the company (
org_renewals_* tools; Manage → Renewals).one_on_onesbooleanrequired1:1s and check-ins are on for the company (
org_one_on_ones_* andorg_check_ins_* tools).integrationsstring[]requiredThe connectors this Bizisy server offers (integrations_connections_list has their state): ids such as jira, linear, asana.
looker_studiobooleanrequiredThe Looker Studio connector is available on this server (Integrations → Looker Studio; data_settings_get gives its link).
time_offbooleanrequiredTime off is usable: on this server and on for the company (timeoff_* tools: booking, balances, approvals, public holidays).
time_clockbooleanrequiredThe time clock is usable: on this server and on for the company (timeclock_* tools: clocking, corrections, month close, exports); timeclock_my_today says whether the company has set it up.
featuresobjectrequiredWhat the company switched on or off in Settings → Modules.
3 fields
modulesobjectrequiredEvery module (timeoff, timeclock, documents, assets, checkins, renewals, hiring, payroll, finance, analytics, pay_equity, more_integrations, bank_verification; all included): on for the company, and offered by this server. Tools of a module that is off answer module_disabled.
aiobjectrequiredAI assistants allowed per side (manage: Bizisy for HR and managers; me: My workspace). Off: connected AI apps are refused with ai_disabled.
2 fields
managebooleanrequiredmebooleanrequired
apiobjectrequiredAPI keys allowed per side. Off: keys are refused with api_disabled and none can be created.
2 fields
managebooleanrequiredmebooleanrequired
pausedobject | nullrequiredSet while the company is paused for unpaid invoices (or missing billing details): only owners and admins can sign in, in the web app, to pay (Settings → Plan & billing), save a card or export data; every other call is refused until every overdue invoice is paid.
3 fields
reason"unpaid" | "details_missing"requiredsincestringrequireddelete_onstring | nullrequiredSet once Bizisy closed the company for it: the data is deleted on this date unless every overdue invoice is paid (or the details added) before.
operatorobjectrequiredSettings only Bizisy support can change for the company (set in its admin console).
4 fields
outbound_email"on" | "off"requiredoff: Bizisy support turned this company's email off (a demo or test company): Bizisy records every email as not sent and sends none, except sign-in and password emails to the company's own logins. Notices still reach people in Bizisy: share invite links and other links in Bizisy, never promise an email.
outbound_email_sincestring | nullrequiredWhen email was turned off (ISO time); null while on.
not_billedbooleanrequiredBizisy support set this company as never billed (a demo or internal company).
limitsobjectrequiredCaps Bizisy support raised for this company, in force now, by limit id (api.key_requests_per_min, shifts.publishes_per_day, mail.
org_daily, timeclock.import_calls_per_day); absent ids are at their default.
permissionsstring[]requiredWhat this login may do (permission names); the apps show and hide features from it.
accessobject | nullrequiredSet when the login has a custom role (Settings → Roles): what it covers. null for owner, admin, hr, viewer and member.
7 fields
role_idstringrequirednamestringrequiredareasobjectrequiredA level per area: none, view, propose, edit or approve.
13 fields
people"none" | "view" | "propose" | "edit" | "approve"requiredprivate"none" | "view" | "propose" | "edit" | "approve"requiredpay"none" | "view" | "propose" | "edit" | "approve"requireddocuments"none" | "view" | "propose" | "edit" | "approve"requiredchecklists"none" | "view" | "propose" | "edit" | "approve"requiredpositions"none" | "view" | "propose" | "edit" | "approve"requiredpay_equity"none" | "view" | "propose" | "edit" | "approve"requiredpayroll"none" | "view" | "propose" | "edit" | "approve"requiredstructure"none" | "view" | "propose" | "edit" | "approve"requiredactivity"none" | "view" | "propose" | "edit" | "approve"requiredtime_off"none" | "view" | "propose" | "edit" | "approve"requiredsetup"none" | "view" | "propose" | "edit" | "approve"requiredsurveys"none" | "view" | "propose" | "edit" | "approve"required
scopedbooleanrequiredThe role covers some people only (its filters): you can act on those people only, and never in bulk.
externalbooleanrequiredAn outsider (not a worker of the company): sees only the people the role covers.
access_untilstring | nullrequiredWhen this access ends (YYYY-MM-DD); outsiders always have one.
machine_sensitivebooleanrequiredAPI keys and AI apps of this login may read private and pay values of the people covered.
partnerobject | nullSet when this session was opened from the partner console by a partner firm's person: everything is recorded as "<you> (via <firm>)".
5 fields
firmstringrequiredfirm_idstringrequiredgrant_idstringrequiredtype"accountant" | "hr_consultant" | "implementation"The firm's partner type: its role here is Accountant, HR partner or Implementation partner.
expires_atstring | nullImplementation partners: when this access ends by itself.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/whoami \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/whoami', {
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/platform/whoami",
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": {
"user": {
"id": "usr1",
"email": "ana@acme.test",
"display_name": "Ana Ferreira",
"language": null
},
"org": {
"id": "o1",
"slug": "acme",
"name": "Acme Lda",
"language": "pt-PT",
"sandbox": false
},
"roles": [
"owner"
],
"audiences": [
"me",
"manage"
],
"person_id": "p1",
"today": "2026-10-07",
"time_zone": "Europe/Lisbon",
"me": {
"name": "Ana Ferreira",
"title": "Head of People",
"manager": null
},
"approvals": {
"job_change": "off",
"termination": "off",
"pay_change": "hr"
},
"app_only": [
{
"tool": "org_pay_add",
"title": "Record a pay change",
"where": "People → the person → Pay",
"url": "https://acme.bizisy.com/manage/people"
}
],
"billing": true,
"documents": true,
"files": true,
"equipment": true,
"features": {
"modules": {
"timeoff": {
"on": true,
"available": true
},
"timeclock": {
"on": true,
"available": true
},
"documents": {
"on": true,
"available": true
},
"assets": {
"on": true,
"available": true
},
"checkins": {
"on": true,
"available": true
},
"renewals": {
"on": true,
"available": true
}
},
"ai": {
"manage": true,
"me": true
},
"api": {
"manage": true,
"me": true
}
},
"integrations": [
"jira",
"linear"
],
"looker_studio": false,
"time_off": false,
"time_clock": false,
"one_on_ones": true,
"renewals": true,
"paused": null,
"operator": {
"outbound_email": "on",
"outbound_email_since": null,
"not_billed": false,
"limits": {}
},
"permissions": [
"org.people.write",
"org.read",
"platform.self"
],
"access": null,
"limited": false
}
}List my sign-in methods#
POST/v1/platform/sign_in_methods.listRead
Lists the ways you can sign in to this organization: password, Google and Microsoft, each with linked (connected to your login) and available (offered on the sign-in page: Bizisy offers it and the organization has it on), plus whether your email address is confirmed (email_verified, null when unknown). Google or Microsoft is connected by the person from My profile in the web app.
- Who can call it
- Me key anyone
- MCP tool
platform_sign_in_methods_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
methodsobject[]required3 fields
provider"password" | "google" | "microsoft"requiredlinkedbooleanrequiredavailablebooleanrequired
email_verifiedboolean | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/sign_in_methods.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/sign_in_methods.list', {
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/platform/sign_in_methods.list",
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": {
"methods": [
{
"provider": "password",
"linked": true,
"available": true
},
{
"provider": "google",
"linked": true,
"available": true
},
{
"provider": "microsoft",
"linked": false,
"available": false
}
],
"email_verified": true
}
}List my API keys#
POST/v1/platform/api_keys.listRead
Lists your own API keys (never the secret).
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_api_keys_liston My Workplace, HR Assistant- 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:
idstringrequirednamestringrequiredaudience"me" | "manage"requiredlast4stringrequiredcreated_atstringrequiredlast_used_atstring | nullrequiredrevokedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/api_keys.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/api_keys.list', {
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/platform/api_keys.list",
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": "k1",
"name": "Claude Code",
"audience": "manage",
"last4": "cdef",
"created_at": "2026-10-04T10:00:00.000Z",
"last_used_at": null,
"revoked": false
}
]
}Revoke an API key#
POST/v1/platform/api_keys.revokeDestructive
Revokes one of your API keys immediately. Clients using it lose access.
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_api_keys_revokeon My Workplace, HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
idstringrequired
Returns
idstringrequiredrevokedtruerequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/api_keys.revoke \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"id":"k1"}'const res = await fetch('https://api.bizisy.com/v1/platform/api_keys.revoke', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"id": "k1"
}),
});
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/platform/api_keys.revoke",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "k1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "k1",
"revoked": true
}
}List connected apps#
POST/v1/platform/connections.listRead
Lists the AI apps (MCP clients) connected to Bizisy by signing in: their name, where they come from, Me or Manage, when connected and last used. Your own by default; in Manage, owners and admins may pass everyone=true for the whole company (with who connected each). Tokens are never shown. A connection disconnects on its own after 30 days without use.
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_connections_liston My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
everyonebooleanOwners and admins in Manage: the whole company.
Returns
An array of objects with 12 fields
An array of objects:
idstringrequiredclient_namestringrequiredclient_kind"cimd" | "dcr"requiredclient_hoststring | nullrequiredFor apps that publish their identity (e.g. claude.ai): the host it is published on.
redirect_hoststringrequiredredirect_kind"web" | "local" | "app"requiredaudience"me" | "manage"requiredcreated_atstringrequiredlast_used_atstring | nullrequiredexpires_atstring | nullrequiredDisconnects on its own if unused until then (renewed on every use).
minebooleanrequireduserobject | nullrequiredWho connected it (only in the everyone view).
3 fields
idstringrequirednamestringrequiredemailstringrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/connections.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"everyone":true}'const res = await fetch('https://api.bizisy.com/v1/platform/connections.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"everyone": true
}),
});
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/platform/connections.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"everyone": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": [
{
"id": "g1",
"client_name": "Claude",
"client_kind": "cimd",
"client_host": "claude.ai",
"redirect_host": "claude.ai",
"redirect_kind": "web",
"audience": "manage",
"created_at": "2026-10-05T10:00:00.000Z",
"last_used_at": "2026-10-05T11:00:00.000Z",
"expires_at": "2026-11-04T11:00:00.000Z",
"mine": true,
"user": {
"id": "usr1",
"name": "Ana Ferreira",
"email": "ana@acme.test"
}
}
]
}Disconnect an app#
POST/v1/platform/connections.revokeDestructive
Disconnects a connected AI app at once: its tokens stop working and it must ask again to reconnect. Your own connections; owners and admins may disconnect anyone's, but only in the web app (over MCP or an API key, your own only). Take id from platform_connections_list.
- Who can call it
- Manage key any Manage role
Me key anyone - Keys and apps
- Only your own connections (owners and admins disconnect others in the app).
- MCP tool
platform_connections_revokeon My Workplace, HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
idstringrequired1–64 characters.
Returns
idstringrequiredrevokedtruerequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/connections.revoke \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"id":"g1"}'const res = await fetch('https://api.bizisy.com/v1/platform/connections.revoke', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"id": "g1"
}),
});
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/platform/connections.revoke",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"id": "g1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "g1",
"revoked": true
}
}AI setup status#
POST/v1/platform/ai.onboarding.statusRead
For the caller only, in this audience: whether the "Connect your AI" journey applies to them (eligible: owners and admins in Manage, everyone in Me) and should show first (show), their own connected apps here with when each first called Bizisy, first made a change and the last tool it used, and the latest change or preview one of their apps made (Activity summary and links). The Bizisy app polls it while someone connects an assistant. Never shows other people's apps or activity.
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_ai_onboarding_statuson My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
8 fields
eligiblebooleanrequiredManage: owners and admins. Me: everyone.
showbooleanrequiredThe journey is still open for you: eligible, no connected app of your own here yet, not put off.
redirectbooleanrequiredManage Home opens the journey first: only for a company created since the journey shipped, once per person (until they have seen it), with no connected app and no API key in use.
stateobjectrequired3 fields
viewed_atstring | nullrequiredassistant"claude" | "chatgpt" | "cursor" | "vscode" | "gemini" | "other"requiredskipped_atstring | nullrequired
appsobject[]required9 fields
idstringrequiredclient_namestringrequiredassistant"claude" | "chatgpt" | "cursor" | "vscode" | "gemini" | "other"requiredconnected_atstringrequiredlast_used_atstring | nullrequiredfirst_call_atstring | nullrequiredIts first tool call.
first_write_atstring | nullrequiredIts first applied change.
last_toolobject | nullrequired2 fields
idstringrequiredtitlestringrequired
last_tool_atstring | nullrequired
first_call_atstring | nullrequiredfirst_write_atstring | nullrequiredlatestobject | nullrequired6 fields
activity_idstringrequiredsummarystringrequiredpreviewbooleanrequiredA preview (dry run): nothing was saved.
appstring | nullrequiredatstringrequiredlinksobject[]required2 fields
labelstringrequiredpathstringrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/ai.onboarding.status \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/ai.onboarding.status', {
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/platform/ai.onboarding.status",
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": {
"eligible": true,
"show": false,
"redirect": false,
"state": {
"viewed_at": "2026-10-05T10:00:00.000Z",
"assistant": "claude",
"skipped_at": null
},
"apps": [
{
"id": "g1",
"client_name": "Claude",
"assistant": "claude",
"connected_at": "2026-10-05T10:02:00.000Z",
"last_used_at": "2026-10-05T10:03:00.000Z",
"first_call_at": "2026-10-05T10:02:30.000Z",
"first_write_at": "2026-10-05T10:05:00.000Z",
"last_tool": {
"id": "org.setup.apply",
"title": "Apply a company setup"
},
"last_tool_at": "2026-10-05T10:05:00.000Z"
}
],
"first_call_at": "2026-10-05T10:02:30.000Z",
"first_write_at": "2026-10-05T10:05:00.000Z",
"latest": {
"activity_id": "01k0000000000000000000000a",
"summary": "Applied company setup: 3 people created",
"preview": false,
"app": "Claude",
"at": "2026-10-05T10:05:00.000Z",
"links": [
{
"label": "People",
"path": "/manage/people"
}
]
}
}
}My two-step sign-in#
POST/v1/platform/me.two_stepRead
Your two-step sign-in: the company's rule (level) and whether it includes you, whether your login has a password and a confirmed email (needed for an authenticator app), whether your current sign-in had a second step, and your authenticator apps. Authenticator apps are added and removed in the Bizisy app (My profile → Two-step sign-in), never through an API key or an AI app.
- Web app only
- Refused for API keys and connected apps. Two-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
- MCP tool
platform_me_two_stepon My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
level"off" | "admins" | "hr" | "everyone"requiredThe company's rule: who must sign in with two steps.
requiredbooleanrequiredWhether the rule includes you.
password_loginbooleanrequiredYour login has a password (authenticator apps protect password sign-ins; Google and Microsoft sign-ins use their own).
email_verifiedbooleanrequiredAn authenticator app needs a confirmed email address first.
signed_in_with_two_stepsbooleanrequiredYour current sign-in had a second step.
factorsobject[]requiredYour authenticator apps (never their secrets).
3 fields
uidstringrequireddisplay_namestring | nullrequiredenrolled_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/me.two_step \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/me.two_step', {
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/platform/me.two_step",
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": {
"level": "admins",
"required": true,
"password_login": true,
"email_verified": true,
"signed_in_with_two_steps": true,
"factors": [
{
"uid": "f1",
"display_name": "Phone",
"enrolled_at": "2026-10-17T10:00:00.000Z"
}
]
}
}Record a change to my authenticator apps#
POST/v1/platform/me.two_step.changedWrite
Called by the Bizisy app right after you added or removed an authenticator app (the change itself is made with Google Identity Platform in your browser): Bizisy reads your authenticator apps again, records the change in Activity and emails you about it. Refused when nothing changed. In the app only.
- Web app only
- Refused for API keys and connected apps. Two-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
- MCP tool
platform_me_two_step_changedon My Workplace, HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
change"added" | "removed"required
Returns
factorsobject[]required3 fields
uidstringrequireddisplay_namestring | nullrequiredenrolled_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/me.two_step.changed \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"change":"added"}'const res = await fetch('https://api.bizisy.com/v1/platform/me.two_step.changed', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"change": "added"
}),
});
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/platform/me.two_step.changed",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"change": "added",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"factors": [
{
"uid": "f1",
"display_name": "Phone",
"enrolled_at": "2026-10-17T10:00:00.000Z"
}
]
}
}Change my language#
POST/v1/platform/language.set_mineWrite
Sets the language Bizisy uses for you: the web app (Me and Manage, on every device and in every company you belong to) and the emails you receive. Languages: en (English), pt-PT (Português), es-ES (Español), de-DE (Deutsch), fr-FR (Français), it-IT (Italiano). null = follow the company default (or, without one, the browser's language). Any signed-in person, for themselves only. platform_whoami returns the current choice (user.language) and the company default (org.language).
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_language_set_mineon My Workplace, HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
language"en" | "pt-PT" | "es-ES" | "de-DE" | "fr-FR" | "it-IT"requiredOne of en, pt-PT, es-ES, de-DE, fr-FR, it-IT, or null to follow the company default.
Returns
language"en" | "pt-PT" | "es-ES" | "de-DE" | "fr-FR" | "it-IT"required
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/language.set_mine \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"language":"de-DE"}'const res = await fetch('https://api.bizisy.com/v1/platform/language.set_mine', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"language": "de-DE"
}),
});
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/platform/language.set_mine",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"language": "de-DE",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"language": "de-DE"
}
}Something missing or wrong on this page? Write to hello@bizisy.com.