API reference
Company settings
Colours and logo, sign-in methods, company language, account status, storage and the data processing agreement.
16 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
Ask Bizisy to allow Ask HR#
POST/v1/platform/ask_hr.requestWrite
Asks Bizisy to allow Ask HR (the AI assistant in My workspace) for your company: Bizisy support is alerted and turns it on, or tells you why not. At most once a day. Owners and admins, in the app.
- Who can call it
- Manage key owner admin
- MCP tool
platform_ask_hr_requeston HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
No input: send {}.
Returns
requested_atstringrequiredalready_allowedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/ask_hr.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/platform/ask_hr.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/platform/ask_hr.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": {
"requested_at": "2026-11-16T10:00:00.000Z",
"already_allowed": false
}
}See the organization colours, sidebar style and logo#
POST/v1/platform/appearance.getRead
Returns the colour palette (emerald, violet, indigo, ocean, amber, rose, graphite or terracotta), the sidebar style (ink = dark sidebar, light = light sidebar tinted with the palette), the company logo (logo_url: a path on the company address, null without one) and whether photos and logos can be uploaded on this server (photos_available).
- Who can call it
- Manage key any Manage role
Me key anyone - MCP tool
platform_appearance_geton My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
palettestring (enum)requiredOne of:
emerald,violet,indigo,ocean,amber,rose,graphite,terracotta.shell"ink" | "light"requiredlogo_urlstring | nullrequiredphotos_availablebooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/appearance.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/appearance.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/platform/appearance.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": {
"palette": "emerald",
"shell": "ink",
"logo_url": "https://acme.bizisy.com/api/org/logo?v=01k0000000000000000000000c",
"photos_available": true
}
}Change the organization colours and sidebar style#
POST/v1/platform/appearance.setWrite
Changes the colour palette and/or the sidebar style used by every page of the organization. Palette: emerald (default), violet, indigo, ocean, amber, rose, graphite, terracotta. Sidebar style: ink (default, dark sidebar) or light (light sidebar tinted with the palette). Send only the fields to change; the other keeps its value. Owners and admins only. The logo has its own actions (platform_appearance_logo_upload / remove).
- Who can call it
- Manage key owner admin
- MCP tool
platform_appearance_seton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
palettestring (enum)Accent colour: emerald (default), violet, indigo, ocean, amber, rose, graphite or terracotta.
One of:
emerald,violet,indigo,ocean,amber,rose,graphite,terracotta.shell"ink" | "light"Sidebar style: ink (default, dark sidebar) or light (light sidebar tinted with the palette).
Returns
palettestring (enum)requiredOne of:
emerald,violet,indigo,ocean,amber,rose,graphite,terracotta.shell"ink" | "light"requiredlogo_urlstring | nullrequiredphotos_availablebooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/appearance.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"palette":"ocean","shell":"ink"}'const res = await fetch('https://api.bizisy.com/v1/platform/appearance.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"palette": "ocean",
"shell": "ink"
}),
});
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/appearance.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"palette": "ocean",
"shell": "ink",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"palette": "ocean",
"shell": "ink",
"logo_url": null,
"photos_available": true
}
}Upload the company logo#
POST/v1/platform/appearance.logo.uploadWrite
Sets the company logo, shown in the sidebar of every page and on the sign-in and invite pages (which anyone who opens the company address can see). 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 about 1.5 MB fits; larger files go through the REST API); the server checks the bytes, fits the whole logo on a transparent square, re-encodes it as a 512×512 WebP and drops all metadata. A new upload replaces the old logo. Owners and admins only. Returns logo_url. Use dry_run to check the image without saving it. rate_limited means the server is busy with other images: retry in a few seconds.
- Who can call it
- Manage key owner admin
- MCP tool
platform_appearance_logo_uploadon HR Assistant- 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 logo file as base64 (a data: URL is accepted): JPEG, PNG or WebP, at most 2 MB.
1–2900000 characters.
Returns
logo_urlstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict payload_too_large rate_limited internal
curl https://api.bizisy.com/v1/platform/appearance.logo.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/platform/appearance.logo.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/platform/appearance.logo.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": {
"logo_url": "https://acme.bizisy.com/api/org/logo?v=01k0000000000000000000000c"
}
}Remove the company logo#
POST/v1/platform/appearance.logo.removeDestructive
Deletes the company logo; the sidebar and sign-in page show the coloured mark again. Succeeds when there is no logo. Owners and admins only.
- Who can call it
- Manage key owner admin
- MCP tool
platform_appearance_logo_removeon HR Assistant- 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
logo_urlstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/appearance.logo.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/platform/appearance.logo.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/platform/appearance.logo.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": {
"logo_url": null
}
}See which sign-in methods are on#
POST/v1/platform/sign_in.getRead
Returns the organization's sign-in methods (methods.password, methods.google, methods.microsoft), each with on (the organization's own choice, enforced on every new sign-in), available (Bizisy offers it at all; password always), linked (how many active members' own logins use it today) and privileged_only (owners and admins who sign in only with it). People can sign in with a method that is on and available. Use linked and privileged_only to tell the user who a change affects. two_step: who must sign in with two steps (level), how many logins each group has (people) and whether your own sign-in had a second step. Owners and admins only.
- Who can call it
- Manage key owner admin
- MCP tool
platform_sign_in_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
methodsobjectrequired3 fields
passwordobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
googleobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
microsoftobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
two_stepobjectrequired3 fields
level"off" | "admins" | "hr" | "everyone"requiredWho must sign in with two steps: off, admins (owners and admins), hr (also HR and custom roles) or everyone. Password sign-ins then need the code from an authenticator app; Google and Microsoft sign-ins count as two-step (their own account security).
peopleobjectrequiredActive logins in each group (hr: HR and custom roles; everyone: the rest), for "who this affects".
3 fields
adminsintegerrequiredhrintegerrequiredeveryoneintegerrequired
youobjectrequiredYour own group, and whether your current sign-in had a second step (required before you can make it required of yourself).
2 fields
tier"admins" | "hr" | "everyone"requiredsigned_in_with_two_stepsbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/sign_in.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/sign_in.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/platform/sign_in.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": {
"methods": {
"password": {
"on": true,
"available": true,
"linked": 12,
"privileged_only": 2
},
"google": {
"on": true,
"available": true,
"linked": 4,
"privileged_only": 0
},
"microsoft": {
"on": true,
"available": false,
"linked": 0,
"privileged_only": 0
}
},
"two_step": {
"level": "off",
"people": {
"admins": 2,
"hr": 1,
"everyone": 9
},
"you": {
"tier": "admins",
"signed_in_with_two_steps": true
}
}
}
}Turn sign-in methods on or off#
POST/v1/platform/sign_in.setWrite
Turns password, Google and Microsoft sign-in on or off for the whole organization. Send only the methods to change, e.g. { "password": false }. Rules: at least one method that Bizisy offers must stay on; a method Bizisy does not offer yet (see available in platform_sign_in_get) cannot be turned on; and you cannot lock yourself out by turning off every method your own login uses (connect Google or Microsoft from My profile first). A method Bizisy does not offer can always be turned off. Turning a method off refuses new sign-ins, invite acceptances and password resets with it; people already signed in stay signed in until their session ends (7 days) or they sign out. API keys are a separate credential and keep working whatever is chosen here (revoke them under API keys). Check linked and privileged_only in platform_sign_in_get to tell the user who is affected, and preview with dry_run first. two_step (off, admins, hr, everyone) makes two-step sign-in required: password sign-ins of those people then need the code from an authenticator app (set up in My profile → Two-step sign-in; asked for at their next sign-in, and sessions opened without one end); Google and Microsoft sign-ins count as two-step (their own account security applies, such as Google 2-Step Verification). People of partner firms sign in through the partner console, with its own sign-in. Not available in a developer sandbox. You make it required of yourself only from a sign-in that had two steps. Owners and admins only.
- Who can call it
- Manage key owner admin
- MCP tool
platform_sign_in_seton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
passwordbooleanEmail and password sign-in: true turns it on, false turns it off.
googlebooleanContinue with Google: true turns it on, false turns it off. Only when available on Bizisy.
microsoftbooleanContinue with Microsoft: true turns it on, false turns it off. Only when available on Bizisy.
two_step"off" | "admins" | "hr" | "everyone"Who must sign in with two steps (spec 2026-10-17-two-step-sign-in): off, admins, hr or everyone.
Returns
methodsobjectrequired3 fields
passwordobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
googleobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
microsoftobjectrequired4 fields
onbooleanrequiredThe organization's own choice: true = turned on here. Enforced on every new sign-in.
availablebooleanrequiredBizisy offers this method at all (password always). People can only use a method that is on AND available.
linkedintegerrequiredActive members whose own login uses this method today.
privileged_onlyintegerrequiredOwners and admins who sign in ONLY with this method (turning it off locks them out).
two_stepobjectrequired3 fields
level"off" | "admins" | "hr" | "everyone"requiredWho must sign in with two steps: off, admins (owners and admins), hr (also HR and custom roles) or everyone. Password sign-ins then need the code from an authenticator app; Google and Microsoft sign-ins count as two-step (their own account security).
peopleobjectrequiredActive logins in each group (hr: HR and custom roles; everyone: the rest), for "who this affects".
3 fields
adminsintegerrequiredhrintegerrequiredeveryoneintegerrequired
youobjectrequiredYour own group, and whether your current sign-in had a second step (required before you can make it required of yourself).
2 fields
tier"admins" | "hr" | "everyone"requiredsigned_in_with_two_stepsbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/sign_in.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"password":true,"google":true,"microsoft":true}'const res = await fetch('https://api.bizisy.com/v1/platform/sign_in.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"password": true,
"google": true,
"microsoft": true
}),
});
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/sign_in.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"password": True,
"google": True,
"microsoft": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"methods": {
"password": {
"on": false,
"available": true,
"linked": 12,
"privileged_only": 2
},
"google": {
"on": true,
"available": true,
"linked": 4,
"privileged_only": 0
},
"microsoft": {
"on": false,
"available": false,
"linked": 0,
"privileged_only": 0
}
},
"two_step": {
"level": "off",
"people": {
"admins": 2,
"hr": 1,
"everyone": 9
},
"you": {
"tier": "admins",
"signed_in_with_two_steps": true
}
}
}
}Change the company language#
POST/v1/platform/language.set_companyWrite
Sets the company's default language: used by everyone who has not chosen their own language (in Me → My profile) and for the company's emails to them. Languages: en (English), pt-PT (Português), es-ES (Español), de-DE (Deutsch), fr-FR (Français), it-IT (Italiano). null = automatic: each person's browser language. People who chose a language keep it. Owners and admins only.
- Who can call it
- Manage key owner admin
- MCP tool
platform_language_set_companyon 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 for automatic (the browser's language).
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_company \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"language":"pt-PT"}'const res = await fetch('https://api.bizisy.com/v1/platform/language.set_company', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"language": "pt-PT"
}),
});
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_company",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"language": "pt-PT",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"language": "pt-PT"
}
}Company account status#
POST/v1/platform/org.statusRead
Whether the company account is active or closing (closed, with its data deleted on delete_after unless an owner reopens it), and whether you may close it (can_close: an owner in the web app). Closing, reopening and the full company export happen only in the web app: send the user to Manage → Settings → Close account.
- Who can call it
- Manage key any Manage role
- MCP tool
platform_org_statuson HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
status"active" | "closing"requiredclosed_atstring | nullrequireddelete_afterstring | nullrequiredcan_closebooleanrequiredThe caller may close the company: an owner signed in to the web app.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/org.status \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/org.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/org.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": {
"status": "active",
"closed_at": null,
"delete_after": null,
"can_close": true
}
}The AI features addendum#
POST/v1/platform/ai_addendum.getRead
The AI features addendum to the data processing agreement (version ai-4): its text in English, German, Spanish, French, Italian or Portuguese, which AI features it covers, and for which of them the company accepted it, when and by whom. Only owners accept it (as the data processing agreement), when the company switches an AI feature on (for Talent insights, in Settings → Talent insights, step 1). Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_ai_addendum_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
lang"en" | "de" | "es" | "fr" | "it" | "pt"Default
"en".
Returns
9 fields
versionstringrequiredpublished_onstringrequiredlang"en" | "de" | "es" | "fr" | "it" | "pt"requiredtextobjectrequired4 fields
titlestringrequiredintrostringrequiredfeaturesobject[]required3 fields
id"insights" | "assistant" | "goal_suggestions"requirednamestringrequiredprocessingstringrequired
paragraphsobject[]required2 fields
headingstringrequiredtextstringrequired
text_hashstringrequiredacceptedobject[]requiredAcceptances, newest first (every version).
7 fields
feature"insights" | "assistant" | "goal_suggestions"requiredversionstringrequiredlang"en" | "de" | "es" | "fr" | "it" | "pt"requiredaccepted_atstringrequiredbystringrequiredWho accepted it (name), or "Former member".
role"owner" | "admin"requiredtext_hashstringrequired
currentobject[]requiredPer feature: whether the current version is accepted.
2 fields
feature"insights" | "assistant" | "goal_suggestions"requiredacceptedbooleanrequired
ownersstring[]requiredThe company's owners: only they accept it (as the data processing agreement).
can_acceptbooleanrequiredThe caller is an owner signed in to the web app.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/ai_addendum.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"lang":"en"}'const res = await fetch('https://api.bizisy.com/v1/platform/ai_addendum.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"lang": "en"
}),
});
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_addendum.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"lang": "en",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"version": "ai-2",
"published_on": "2026-11-14",
"lang": "en",
"text": {
"title": "AI features addendum to the data processing agreement",
"intro": "This addendum is part of the data processing agreement between the Customer and Wisely Lda (Bizisy).",
"features": [
{
"id": "insights",
"name": "Talent insights",
"processing": "Profiling of the Customer's employees to work out advisory bands."
}
],
"paragraphs": [
{
"heading": "No automated decisions",
"text": "Bands and suggestions are advisory."
}
]
},
"text_hash": "b3a1c0ffee0000000000000000000000000000000000000000000000000000aa",
"accepted": [
{
"feature": "insights",
"version": "ai-2",
"lang": "en",
"accepted_at": "2026-11-10T09:00:00.000Z",
"by": "Ana Costa",
"role": "owner",
"text_hash": "b3a1c0ffee0000000000000000000000000000000000000000000000000000aa"
}
],
"current": [
{
"feature": "insights",
"accepted": true
}
],
"owners": [
"Ana Costa"
],
"can_accept": true
}
}Ask an owner to accept the AI features addendum#
POST/v1/platform/ai_addendum.requestWrite
An admin (or HR) preparing an AI feature asks the company's owners to accept the AI features addendum: each owner gets an in-app notice leading to the step. Nothing is accepted. In the app only (API keys and AI assistants are refused); 3 a day per company.
- Web app only
- Refused for API keys and connected apps. Asking owners to accept the AI features addendum is done in the Bizisy app.
- MCP tool
platform_ai_addendum_requeston HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
feature"insights" | "assistant" | "goal_suggestions"required
Returns
askedintegerrequiredalready_acceptedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/ai_addendum.request \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"feature":"insights"}'const res = await fetch('https://api.bizisy.com/v1/platform/ai_addendum.request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"feature": "insights"
}),
});
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/ai_addendum.request",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"feature": "insights",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"asked": 1,
"already_accepted": false
}
}See the data processing agreement#
POST/v1/platform/dpa.getRead
Bizisy's data processing agreement with the company (GDPR Art. 28; Bizisy, run by Wisely Lda, is the processor, the company the controller): the current version (1.3) and its full text, whether the company accepted it (status not_accepted, accepted, or new_version when only an older version was), who accepted which version and when, and the SHA-256 of the text. Owners, admins and HR. Only an owner accepts it, in the web app (Settings → Data & privacy): an assistant can explain it, never accept it.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_dpa_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
13 fields
versionstringrequiredThe current version (shown on the agreement).
published_onstringrequiredapplies_fromstringrequireddraftbooleanrequiredThe text is a draft for legal review.
changesstring | nullrequiredWhat changed since the previous version.
text_hashstringrequiredSHA-256 of the current version's text.
status"not_accepted" | "accepted" | "new_version"requirednot_accepted: never accepted; accepted: this version is; new_version: an older version was, an owner should accept this one.
acceptedobject | nullrequiredThe acceptance of the current version.
7 fields
versionstringrequiredaccepted_atstringrequirednamestringrequiredtitlestringrequiredlegal_namestringrequiredregistrationstringrequiredtext_hashstringrequiredSHA-256 of the exact text accepted.
previousobject | nullrequiredThe latest acceptance of an older version (status new_version).
7 fields
versionstringrequiredaccepted_atstringrequirednamestringrequiredtitlestringrequiredlegal_namestringrequiredregistrationstringrequiredtext_hashstringrequiredSHA-256 of the exact text accepted.
historyobject[]requiredEvery acceptance, newest first.
7 fields
versionstringrequiredaccepted_atstringrequirednamestringrequiredtitlestringrequiredlegal_namestringrequiredregistrationstringrequiredtext_hashstringrequiredSHA-256 of the exact text accepted.
documentobjectrequired4 fields
titlestringrequiredpartiesstring[]requiredsectionsobject[]required3 fields
idstringrequiredtitlestringrequiredparagraphsstring[]required
annexesobject[]required5 fields
idstringrequiredtitlestringrequiredparagraphsstring[]requiredtableobject2 fields
headstring[]requiredrowsstring[][]required
liststring[]
prefillobjectrequiredFrom the billing details or the first legal entity.
2 fields
legal_namestring | nullrequiredregistrationstring | nullrequired
can_acceptbooleanrequiredThe caller is an owner signed in to the web app.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/dpa.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/dpa.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/platform/dpa.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": {
"version": "1.0",
"published_on": "2026-10-12",
"applies_from": "2026-10-12",
"draft": true,
"changes": null,
"text_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"status": "accepted",
"accepted": {
"version": "1.0",
"accepted_at": "2026-11-12T10:00:00.000Z",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"text_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"previous": null,
"history": [
{
"version": "1.0",
"accepted_at": "2026-11-12T10:00:00.000Z",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"text_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"document": {
"title": "Data Processing Agreement",
"parties": [
"The customer organization named on the acceptance record (the “Customer”, the controller), and"
],
"sections": [
{
"id": "scope",
"title": "1. Scope and roles",
"paragraphs": [
"This agreement applies to the personal data Bizisy processes on the Customer’s behalf."
]
}
],
"annexes": [
{
"id": "annex-3",
"title": "Annex III. Subprocessors",
"paragraphs": [],
"table": {
"head": [
"Subprocessor",
"What for",
"Where"
],
"rows": [
[
"Google Cloud (Google)",
"Application servers and database",
"europe-west1, Belgium (EU)"
]
]
}
}
]
},
"prefill": {
"legal_name": "Acme, Lda",
"registration": "PT501442600"
},
"can_accept": true
}
}Download the data processing agreement#
POST/v1/platform/dpa.documentRead
The current data processing agreement as a PDF (base64), with the company's acceptance record as its last page once an owner accepted it. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_dpa_documenton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
filenamestringrequiredcontent_type"application/pdf"requireddata_base64stringrequiredversionstringrequiredacceptedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/dpa.document \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/dpa.document', {
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/dpa.document",
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": {
"filename": "bizisy-dpa-v1.0-accepted.pdf",
"content_type": "application/pdf",
"data_base64": "JVBERi0xLjcK",
"version": "1.0",
"accepted": true
}
}Accept the data processing agreement#
POST/v1/platform/dpa.acceptWrite
An owner accepts the current version (1.3) of the data processing agreement for the company, with their name and title and the company's legal name and registration or VAT number. Recorded with the SHA-256 of the exact text; each version is accepted once. Owners only, in the web app (Settings → Data & privacy): API keys and AI assistants are refused. Preview with dry_run.
- Web app only
- Refused for API keys and connected apps. The data processing agreement is accepted in the app only, by an owner.
- MCP tool
platform_dpa_accepton HR Assistant- 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
versionstringrequiredThe version the owner read (must be the current one).
namestringrequired2–100 characters.
titlestringrequiredTheir title or role at the company, e.g. "CEO".
2–100 characters.
legal_namestringrequired2–200 characters.
registrationstringrequiredCompany registration or VAT number.
2–40 characters.
confirmtruerequiredThe owner confirms they may accept it for the company.
Returns
7 fields
versionstringrequiredaccepted_atstringrequirednamestringrequiredtitlestringrequiredlegal_namestringrequiredregistrationstringrequiredtext_hashstringrequiredSHA-256 of the exact text accepted.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/dpa.accept \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"version": "1.3",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"confirm": true
}'const res = await fetch('https://api.bizisy.com/v1/platform/dpa.accept', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"version": "1.3",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"confirm": true
}),
});
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/dpa.accept",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"version": "1.3",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"confirm": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"version": "1.3",
"accepted_at": "2026-11-12T10:00:00.000Z",
"name": "Ana Ferreira",
"title": "CEO",
"legal_name": "Acme, Lda",
"registration": "PT501442600",
"text_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}See storage#
POST/v1/platform/storage.getRead
Returns the company's storage: bytes stored now (documents, profile photos and the logo) per module, the highest size this month, the storage limit (included: 1 GB on Free, 5 GB from 10 active people, plus extra GB chosen at €1 each a month; owners and admins raise it with platform_storage_limit_set in Settings → Plan & billing) and the upload limits (largest file, self uploads per person per month). Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_storage_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
10 fields
bytesintegerrequiredBytes stored now: documents, profile photos and the company logo.
filesintegerrequiredmonthstringrequiredThe current billing month (YYYY-MM, UTC).
peak_bytesintegerrequiredThe highest size reached this month.
limit_gbintegerrequiredThe company's storage limit (spec 2026-10-20 C8): included (1 GB on Free, 5 GB from 10 active people) plus the extra GB chosen in Settings → Plan & billing (€1 per GB a month). Uploads past it are refused.
included_gbintegerrequiredextra_gbintegerrequiredlimitsobjectrequired3 fields
max_file_mbintegerrequiredLargest file, in MB (1–100; default 25).
From 1 to 100.
self_files_per_monthintegerrequiredFiles each person may add to "From me" per month (0–200; 0 turns self upload off; default 20).
From 0 to 200.
self_mb_per_monthintegerrequiredMB each person may add to "From me" per month (0–1000; 0 turns self upload off; default 100).
From 0 to 1000.
defaultsobjectrequired3 fields
max_file_mbintegerrequiredLargest file, in MB (1–100; default 25).
From 1 to 100.
self_files_per_monthintegerrequiredFiles each person may add to "From me" per month (0–200; 0 turns self upload off; default 20).
From 0 to 200.
self_mb_per_monthintegerrequiredMB each person may add to "From me" per month (0–1000; 0 turns self upload off; default 100).
From 0 to 1000.
by_moduleobject[]requireddocuments = documents; org = profile photos; platform = the company logo.
3 fields
modulestringrequiredbytesintegerrequiredfilesintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/storage.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/storage.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/platform/storage.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": {
"bytes": 320000000,
"files": 41,
"month": "2026-10",
"peak_bytes": 340000000,
"limit_gb": 1,
"included_gb": 1,
"extra_gb": 0,
"limits": {
"max_file_mb": 25,
"self_files_per_month": 20,
"self_mb_per_month": 100
},
"defaults": {
"max_file_mb": 25,
"self_files_per_month": 20,
"self_mb_per_month": 100
},
"by_module": [
{
"module": "documents",
"bytes": 318000000,
"files": 30
},
{
"module": "org",
"bytes": 2000000,
"files": 11
}
]
}
}Change storage limits#
POST/v1/platform/storage.set_limitsWrite
Changes the upload limits: largest file (1–100 MB) and self uploads per person per month (0–200 files and 0–1000 MB; 0 turns "From me" uploads off). Send only the limits to change. The company storage limit itself is raised or lowered with platform_storage_limit_set (Settings → Plan & billing). Owners and admins.
- Who can call it
- Manage key owner admin
- MCP tool
platform_storage_set_limitson HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
max_file_mbintegerLargest file, in MB (1–100; default 25).
From 1 to 100.
self_files_per_monthintegerFiles each person may add to "From me" per month (0–200; 0 turns self upload off; default 20).
From 0 to 200.
self_mb_per_monthintegerMB each person may add to "From me" per month (0–1000; 0 turns self upload off; default 100).
From 0 to 1000.
Returns
10 fields
bytesintegerrequiredBytes stored now: documents, profile photos and the company logo.
filesintegerrequiredmonthstringrequiredThe current billing month (YYYY-MM, UTC).
peak_bytesintegerrequiredThe highest size reached this month.
limit_gbintegerrequiredThe company's storage limit (spec 2026-10-20 C8): included (1 GB on Free, 5 GB from 10 active people) plus the extra GB chosen in Settings → Plan & billing (€1 per GB a month). Uploads past it are refused.
included_gbintegerrequiredextra_gbintegerrequiredlimitsobjectrequired3 fields
max_file_mbintegerrequiredLargest file, in MB (1–100; default 25).
From 1 to 100.
self_files_per_monthintegerrequiredFiles each person may add to "From me" per month (0–200; 0 turns self upload off; default 20).
From 0 to 200.
self_mb_per_monthintegerrequiredMB each person may add to "From me" per month (0–1000; 0 turns self upload off; default 100).
From 0 to 1000.
defaultsobjectrequired3 fields
max_file_mbintegerrequiredLargest file, in MB (1–100; default 25).
From 1 to 100.
self_files_per_monthintegerrequiredFiles each person may add to "From me" per month (0–200; 0 turns self upload off; default 20).
From 0 to 200.
self_mb_per_monthintegerrequiredMB each person may add to "From me" per month (0–1000; 0 turns self upload off; default 100).
From 0 to 1000.
by_moduleobject[]requireddocuments = documents; org = profile photos; platform = the company logo.
3 fields
modulestringrequiredbytesintegerrequiredfilesintegerrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/storage.set_limits \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"max_file_mb":25,"self_files_per_month":0,"self_mb_per_month":0}'const res = await fetch('https://api.bizisy.com/v1/platform/storage.set_limits', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"max_file_mb": 25,
"self_files_per_month": 0,
"self_mb_per_month": 0
}),
});
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/storage.set_limits",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"max_file_mb": 25,
"self_files_per_month": 0,
"self_mb_per_month": 0,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"bytes": 320000000,
"files": 41,
"month": "2026-10",
"peak_bytes": 340000000,
"limit_gb": 1,
"included_gb": 1,
"extra_gb": 0,
"limits": {
"max_file_mb": 25,
"self_files_per_month": 20,
"self_mb_per_month": 100
},
"defaults": {
"max_file_mb": 25,
"self_files_per_month": 20,
"self_mb_per_month": 100
},
"by_module": [
{
"module": "documents",
"bytes": 318000000,
"files": 30
},
{
"module": "org",
"bytes": 2000000,
"files": 11
}
]
}
}Something missing or wrong on this page? Write to hello@bizisy.com.