API reference
Members and roles
Everyone with access to the company, their roles (built-in and custom), outsiders' end dates, linking logins to people, and your partner firms' access (Partner access).
17 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
List roles#
POST/v1/platform/roles.listRead
Lists the company's custom roles (Settings → Roles) with what each may do (a level per area: none, view, propose, edit, approve), the people it covers (scope: legal entities, teams with their sub-teams, locations, the holder's reporting line, named people, saved groups; all empty means everyone), whether its API keys and AI apps may read private and pay values (machine_sensitive), and how many logins hold it. Also the ready-made templates and the limits. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_roles_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
rolesobject[]required10 fields
idstringrequirednamestringrequireddescriptionstring | nullrequiredtemplatestring | nullrequiredareasobjectrequired13 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
scopeobjectrequired6 fields
entitiesstring[]requiredunitsstring[]requiredlocationsstring[]requiredreporting_linebooleanrequiredpeoplestring[]requiredgroupsstring[]required
machine_sensitivebooleanrequiredmembersintegerrequiredLogins with this role (active or not).
managedbooleanThe role of a partner firm's access (Accountant, HR partner, Implementation partner): read-only here, changed in Settings → Partner access.
updated_atstringrequired
templatesobject[]required6 fields
id"payroll_bureau" | "accountant" | "auditor" | "recruiter" | "department_lead"requirednamestringrequireddescriptionstringrequiredexternalbooleanrequiredareasobjectrequired13 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
scopeobjectrequired6 fields
entitiesstring[]requiredunitsstring[]requiredlocationsstring[]requiredreporting_linebooleanrequiredpeoplestring[]requiredgroupsstring[]required
limitsobjectrequired3 fields
rolesintegerrequiredoutsidersintegerrequiredoutsiders_usedintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/roles.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/roles.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/roles.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": {
"roles": [
{
"id": "r1",
"name": "Payroll bureau",
"description": "Runs payroll for Acme Portugal.",
"template": "payroll_bureau",
"areas": {
"people": "view",
"private": "view",
"pay": "view",
"documents": "view"
},
"scope": {
"entities": [
"e1"
],
"units": [],
"locations": [],
"reporting_line": false,
"people": [],
"groups": []
},
"machine_sensitive": false,
"members": 1,
"updated_at": "2026-10-08T10:00:00.000Z"
}
],
"templates": [
{
"id": "payroll_bureau",
"name": "Payroll bureau",
"description": "Runs payroll outside the company.",
"external": true,
"areas": {
"people": "view",
"private": "view",
"pay": "view",
"documents": "view"
},
"scope": {
"entities": [],
"units": [],
"locations": [],
"reporting_line": false,
"people": [],
"groups": []
}
}
],
"limits": {
"roles": 30,
"outsiders": 25,
"outsiders_used": 1
}
}
}Create a role#
POST/v1/platform/roles.createWrite
Creates a custom role (owners and admins, in the app only). areas: a level per area (people: none/view/propose/edit/approve; private: none/view/edit; pay: none/view/edit/approve; documents, checklists, positions, pay_equity: none/view/edit; structure: none/edit; activity: none/view). scope: who it covers (legal entities, teams, locations, the holder's reporting line, named people, saved groups; empty: everyone). machine_sensitive lets its API keys and AI apps read private and pay values (off by default). At most 30 roles; names are unique.
- Web app only
- Refused for API keys and connected apps. Roles are created in the app only, so an assistant can never widen anyone's access.
- MCP tool
platform_roles_createon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
namestringrequired1–60 characters.
descriptionstringUp to 300 characters.
template"payroll_bureau" | "accountant" | "auditor" | "recruiter" | "department_lead"areasobjectrequired13 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
scopeobjectDefault
{}.6 fields
entitiesstring[]1–64 characters. Up to 100 items.
unitsstring[]1–64 characters. Up to 200 items.
locationsstring[]1–64 characters. Up to 200 items.
reporting_linebooleanDefault
false.peoplestring[]1–64 characters. Up to 500 items.
groupsstring[]Saved groups (
org_groups_list): in any of them today. A group with a private field can't scope a role; one with job details needs People and jobs at View or more.1–64 characters. Up to 20 items.
machine_sensitivebooleanDefault
false.
Returns
10 fields
idstringrequirednamestringrequireddescriptionstring | nullrequiredtemplatestring | nullrequiredareasobjectrequired13 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
scopeobjectrequired6 fields
entitiesstring[]requiredunitsstring[]requiredlocationsstring[]requiredreporting_linebooleanrequiredpeoplestring[]requiredgroupsstring[]required
machine_sensitivebooleanrequiredmembersintegerrequiredLogins with this role (active or not).
managedbooleanThe role of a partner firm's access (Accountant, HR partner, Implementation partner): read-only here, changed in Settings → Partner access.
updated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/roles.create \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"name": "Department lead",
"description": "Sales",
"template": "department_lead",
"areas": {
"people": "approve",
"checklists": "edit"
},
"scope": {
"units": [
"u2"
],
"reporting_line": true
},
"machine_sensitive": false
}'const res = await fetch('https://api.bizisy.com/v1/platform/roles.create', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"name": "Department lead",
"description": "Sales",
"template": "department_lead",
"areas": {
"people": "approve",
"checklists": "edit"
},
"scope": {
"units": [
"u2"
],
"reporting_line": true
},
"machine_sensitive": false
}),
});
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/roles.create",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Department lead",
"description": "Sales",
"template": "department_lead",
"areas": {
"people": "approve",
"checklists": "edit",
},
"scope": {
"units": [
"u2",
],
"reporting_line": True,
},
"machine_sensitive": False,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "r1",
"name": "Department lead",
"description": "Sales",
"template": "department_lead",
"areas": {
"people": "view",
"private": "view",
"pay": "view",
"documents": "view"
},
"scope": {
"entities": [
"e1"
],
"units": [],
"locations": [],
"reporting_line": false,
"people": [],
"groups": []
},
"machine_sensitive": false,
"members": 1,
"updated_at": "2026-10-08T10:00:00.000Z"
}
}Change a role#
POST/v1/platform/roles.updateWrite
Changes a custom role (owners and admins, in the app only): name, description, areas (replaced whole), scope (replaced whole) or machine_sensitive. Takes effect on the next request of every login holding it.
- Web app only
- Refused for API keys and connected apps. Roles are changed in the app only.
- MCP tool
platform_roles_updateon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
role_idstringrequirednamestring1–60 characters.
descriptionstring | nullUp to 300 characters.
areasobject13 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
scopeobject6 fields
entitiesstring[]1–64 characters. Up to 100 items.
unitsstring[]1–64 characters. Up to 200 items.
locationsstring[]1–64 characters. Up to 200 items.
reporting_linebooleanDefault
false.peoplestring[]1–64 characters. Up to 500 items.
groupsstring[]Saved groups (
org_groups_list): in any of them today. A group with a private field can't scope a role; one with job details needs People and jobs at View or more.1–64 characters. Up to 20 items.
machine_sensitiveboolean
Returns
10 fields
idstringrequirednamestringrequireddescriptionstring | nullrequiredtemplatestring | nullrequiredareasobjectrequired13 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
scopeobjectrequired6 fields
entitiesstring[]requiredunitsstring[]requiredlocationsstring[]requiredreporting_linebooleanrequiredpeoplestring[]requiredgroupsstring[]required
machine_sensitivebooleanrequiredmembersintegerrequiredLogins with this role (active or not).
managedbooleanThe role of a partner firm's access (Accountant, HR partner, Implementation partner): read-only here, changed in Settings → Partner access.
updated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/roles.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"role_id": "r1",
"areas": {
"pay": "view"
},
"scope": {
"entities": [
"e1"
]
},
"machine_sensitive": true,
"description": null
}'const res = await fetch('https://api.bizisy.com/v1/platform/roles.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"role_id": "r1",
"areas": {
"pay": "view"
},
"scope": {
"entities": [
"e1"
]
},
"machine_sensitive": true,
"description": null
}),
});
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/roles.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"role_id": "r1",
"areas": {
"pay": "view",
},
"scope": {
"entities": [
"e1",
],
},
"machine_sensitive": True,
"description": None,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "r1",
"name": "Payroll bureau",
"description": null,
"template": "payroll_bureau",
"areas": {
"people": "view",
"private": "view",
"pay": "view",
"documents": "view"
},
"scope": {
"entities": [
"e1"
],
"units": [],
"locations": [],
"reporting_line": false,
"people": [],
"groups": []
},
"machine_sensitive": true,
"members": 1,
"updated_at": "2026-10-08T10:00:00.000Z"
}
}Delete a role#
POST/v1/platform/roles.deleteDestructive
Deletes a custom role nobody holds (owners and admins, in the app only). A role still held by a login is a conflict: give those logins another role first (platform_members_set_role).
- Web app only
- Refused for API keys and connected apps. Roles are deleted in the app only.
- MCP tool
platform_roles_deleteon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
role_idstringrequired
Returns
idstringrequirednamestringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/roles.delete \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"role_id":"r1"}'const res = await fetch('https://api.bizisy.com/v1/platform/roles.delete', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"role_id": "r1"
}),
});
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/roles.delete",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"role_id": "r1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "r1",
"name": "Payroll bureau"
}
}List members and roles#
POST/v1/platform/members.listRead
Lists everyone who has, or was given, access to this organization: email, name, roles (owner, admin, hr, viewer, member), status, whether they have signed in yet (has_login) and the linked person_id. Read this before changing roles.
- Who can call it
- Manage key owner admin hr
- MCP tool
platform_members_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
An array of objects with 14 fields
An array of objects:
membership_idstringrequireduser_idstringrequiredemailstringrequirednamestringrequiredrolesstring[]requiredstatus"active" | "disabled"requiredperson_idstring | nullrequiredhas_loginbooleanrequiredrole_idstring | nullrequiredA custom role (Settings → Roles); roles is then ["member"].
role_namestring | nullrequiredexternalbooleanrequiredAn outsider (not a worker of the company).
access_untilstring | nullrequiredWhen their access ends (YYYY-MM-DD); outsiders always have one.
link_requestedbooleanrequiredME-8: this login is not linked to a person and asked HR to link it.
accountant_firmstring | nullA login of a partner firm's person through its partner access (Settings → Partner access): managed there, never here.
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/members.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/members.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/members.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": [
{
"membership_id": "m1",
"user_id": "usr1",
"email": "ana@acme.test",
"name": "Ana Ferreira",
"roles": [
"hr"
],
"status": "active",
"person_id": "p1",
"has_login": true,
"role_id": null,
"role_name": null,
"external": false,
"access_until": null,
"link_requested": false
}
]
}Change a member's role#
POST/v1/platform/members.set_roleWrite
Sets the single role of a member: a built-in role (role: owner, admin, hr, viewer or member) or a custom role (role_id from platform_roles_list; owners and admins, in the app only, never over an API key or MCP). Only owners can grant or remove the owner role. The last owner cannot be demoted. Takes effect on their next request.
- Who can call it
- Manage key owner admin
- Keys and apps
- Built-in roles only: a custom role is given in the app.
- MCP tool
platform_members_set_roleon 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
membership_idstringrequiredrole"owner" | "admin" | "hr" | "viewer" | "member"role_idstring
Returns
14 fields
membership_idstringrequireduser_idstringrequiredemailstringrequirednamestringrequiredrolesstring[]requiredstatus"active" | "disabled"requiredperson_idstring | nullrequiredhas_loginbooleanrequiredrole_idstring | nullrequiredA custom role (Settings → Roles); roles is then ["member"].
role_namestring | nullrequiredexternalbooleanrequiredAn outsider (not a worker of the company).
access_untilstring | nullrequiredWhen their access ends (YYYY-MM-DD); outsiders always have one.
link_requestedbooleanrequiredME-8: this login is not linked to a person and asked HR to link it.
accountant_firmstring | nullA login of a partner firm's person through its partner access (Settings → Partner access): managed there, never here.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.set_role \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"membership_id":"m1","role":"viewer"}'const res = await fetch('https://api.bizisy.com/v1/platform/members.set_role', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"membership_id": "m1",
"role": "viewer"
}),
});
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/members.set_role",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"membership_id": "m1",
"role": "viewer",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"membership_id": "m1",
"user_id": "usr1",
"email": "ana@acme.test",
"name": "Ana Ferreira",
"roles": [
"viewer"
],
"status": "active",
"person_id": "p1",
"has_login": true,
"role_id": null,
"role_name": null,
"external": false,
"access_until": null,
"link_requested": false
}
}Change when an outsider's access ends#
POST/v1/platform/members.set_access_untilWrite
Moves the day an outsider's access ends (YYYY-MM-DD, after today, at most three years ahead), or ends it today with end_now. Owners and admins, in the web app only. Sign-in, API keys and AI apps stop on that day.
- Web app only
- Refused for API keys and connected apps. An outsider's end date is changed in the app only.
- MCP tool
platform_members_set_access_untilon 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
membership_idstringrequiredaccess_untilstringend_nowbooleanDefault
false.
Returns
14 fields
membership_idstringrequireduser_idstringrequiredemailstringrequirednamestringrequiredrolesstring[]requiredstatus"active" | "disabled"requiredperson_idstring | nullrequiredhas_loginbooleanrequiredrole_idstring | nullrequiredA custom role (Settings → Roles); roles is then ["member"].
role_namestring | nullrequiredexternalbooleanrequiredAn outsider (not a worker of the company).
access_untilstring | nullrequiredWhen their access ends (YYYY-MM-DD); outsiders always have one.
link_requestedbooleanrequiredME-8: this login is not linked to a person and asked HR to link it.
accountant_firmstring | nullA login of a partner firm's person through its partner access (Settings → Partner access): managed there, never here.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.set_access_until \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"membership_id":"m1","access_until":"2027-03-31"}'const res = await fetch('https://api.bizisy.com/v1/platform/members.set_access_until', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"membership_id": "m1",
"access_until": "2027-03-31"
}),
});
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/members.set_access_until",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"membership_id": "m1",
"access_until": "2027-03-31",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"membership_id": "m1",
"user_id": "usr1",
"email": "ana@acme.test",
"name": "Ana Ferreira",
"roles": [
"member"
],
"status": "active",
"person_id": "p1",
"has_login": true,
"role_id": "r1",
"role_name": "Payroll bureau",
"external": true,
"access_until": "2027-03-31",
"link_requested": false
}
}Disable a member's access#
POST/v1/platform/members.disableDestructive
Disables a membership: their sessions and API keys stop working immediately. You cannot disable yourself or the last owner; only owners can disable owners.
- Who can call it
- Manage key owner admin
- MCP tool
platform_members_disableon 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
membership_idstringrequired
Returns
14 fields
membership_idstringrequireduser_idstringrequiredemailstringrequirednamestringrequiredrolesstring[]requiredstatus"active" | "disabled"requiredperson_idstring | nullrequiredhas_loginbooleanrequiredrole_idstring | nullrequiredA custom role (Settings → Roles); roles is then ["member"].
role_namestring | nullrequiredexternalbooleanrequiredAn outsider (not a worker of the company).
access_untilstring | nullrequiredWhen their access ends (YYYY-MM-DD); outsiders always have one.
link_requestedbooleanrequiredME-8: this login is not linked to a person and asked HR to link it.
accountant_firmstring | nullA login of a partner firm's person through its partner access (Settings → Partner access): managed there, never here.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.disable \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"membership_id":"m1"}'const res = await fetch('https://api.bizisy.com/v1/platform/members.disable', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"membership_id": "m1"
}),
});
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/members.disable",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"membership_id": "m1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"membership_id": "m1",
"user_id": "usr1",
"email": "ana@acme.test",
"name": "Ana Ferreira",
"roles": [
"hr"
],
"status": "disabled",
"person_id": "p1",
"has_login": true,
"role_id": null,
"role_name": null,
"external": false,
"access_until": null,
"link_requested": false
}
}Link a login to a person#
POST/v1/platform/members.link_personWrite
Sets which person record a member's login belongs to (person_id), or clears it with person_id null. The link decides whose own profile, team and self-service data that login sees. Use it when someone signed in but their login is not linked to their person (for example after org_setup_init warns about it): take membership_id from platform_members_list and person_id from org_people_list. A person is linked to at most one login, so linking moves the person away from any other login. The person must exist and not be erased. Owners and admins only; only owners can relink an owner's login; nobody can move or clear the link of their own login once it is linked.
- Who can call it
- Manage key owner admin
- MCP tool
platform_members_link_personon 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
membership_idstringrequiredperson_idstring | nullrequired
Returns
14 fields
membership_idstringrequireduser_idstringrequiredemailstringrequirednamestringrequiredrolesstring[]requiredstatus"active" | "disabled"requiredperson_idstring | nullrequiredhas_loginbooleanrequiredrole_idstring | nullrequiredA custom role (Settings → Roles); roles is then ["member"].
role_namestring | nullrequiredexternalbooleanrequiredAn outsider (not a worker of the company).
access_untilstring | nullrequiredWhen their access ends (YYYY-MM-DD); outsiders always have one.
link_requestedbooleanrequiredME-8: this login is not linked to a person and asked HR to link it.
accountant_firmstring | nullA login of a partner firm's person through its partner access (Settings → Partner access): managed there, never here.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.link_person \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"membership_id":"m1","person_id":"p1"}'const res = await fetch('https://api.bizisy.com/v1/platform/members.link_person', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"membership_id": "m1",
"person_id": "p1"
}),
});
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/members.link_person",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"membership_id": "m1",
"person_id": "p1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"membership_id": "m1",
"user_id": "usr1",
"email": "ana@acme.test",
"name": "Ana Ferreira",
"roles": [
"hr"
],
"status": "active",
"person_id": null,
"has_login": true,
"role_id": null,
"role_name": null,
"external": false,
"access_until": null,
"link_requested": false
}
}Ask HR to link my login#
POST/v1/platform/members.link_requestWrite
ME-8: when your login is not linked to your person record (My workspace says so), asks the company's owners, admins and HR to link it: they see it on their Home and link it in Members. Asking again changes nothing. Refused once linked.
- Who can call it
- Me key anyone
- MCP tool
platform_members_link_requeston My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
No input: send {}.
Returns
requested_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.link_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/members.link_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/members.link_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-10-09T10:00:00.000Z"
}
}Reset a member's two-step sign-in#
POST/v1/platform/members.two_step.resetWrite
Removes every authenticator app from a member's login, for example when they lost their phone. They sign in with their password next time and, when the company requires two-step sign-in of them, set up a new authenticator app. They get an email about it. Owners and admins, in the app; never your own login (remove your own in My profile → Two-step sign-in). not_found for an unknown membership.
- Who can call it
- Manage key owner admin
- MCP tool
platform_members_two_step_reseton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
membership_idstringrequired
Returns
membership_idstringrequiredremovedintegerrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/members.two_step.reset \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"membership_id":"m2"}'const res = await fetch('https://api.bizisy.com/v1/platform/members.two_step.reset', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"membership_id": "m2"
}),
});
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/members.two_step.reset",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"membership_id": "m2",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"membership_id": "m2",
"removed": 1
}
}Partner access#
POST/v1/platform/partner_access.listRead
The partner firms (accountants, HR consultants, implementation partners) that asked for, have or had access to the company: firm (type, name, country, registration, website), status (requested, active, declined, revoked), what the access covers (fixed areas and the extras the owner added), who at the firm can open the company and when it was last opened. Owners only. An assistant can read this but never approve, change or revoke access: tell the owner to do it in Settings → Partner access.
- Who can call it
- Manage key owner
- MCP tool
platform_partner_access_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
grantsobject[]required20 fields
idstringrequiredfirmobjectrequired7 fields
idstringrequirednamestringrequiredcountrystringrequiredcitystring | nullrequiredwebsitestring | nullrequiredregistrationobject | nullrequired3 fields
scheme"occ" | "colegio" | "tax_id" | "other"requirednumberstringrequiredlabelstring | nullrequired
status"pending" | "approved" | "rejected" | "suspended"required
type"accountant" | "hr_consultant" | "implementation"requiredThe firm's partner type, which sets its role: Accountant (read-only), HR partner or Implementation partner (setup, for a limited time).
rolestringrequiredThe role the firm's people get in the company.
status"requested" | "active" | "expired" | "declined" | "revoked"requiredextras_allowed"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner may add for this type.
neverstring (enum)[]requiredWhat this role can never do.
One of:
settings_billing,members_roles,credentials,closure,any_change,legal_entities,sign_in,pay_private,webhooks_exports.expires_atstring | nullrequiredImplementation partners: when the access ends by itself (renewed by a new request).
access_daysinteger | nullrequiredextras"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner added to the fixed access: private (contact, address and payroll identifiers), documents (every company and person document), checklists.
fixedstring (enum)[]requiredWhat the role always covers. Accountant (read-only): people, pay, payroll, time_off (who is away; absences in payroll exports), accountant_documents. HR partner: people_edit, private_edit, structure_edit, positions_edit, checklists_edit,
documents_edit, time_off_settings. Implementation partner: people_view, structure_edit, setup_edit (imports and integrations setup), time_off_settings.One of:
people,pay,payroll,time_off,accountant_documents,people_edit,private_edit,structure_edit,positions_edit,checklists_edit,documents_edit,time_off_settings,people_view,setup_edit.messagestring | nullrequiredThe firm's note to the owner (in the app only).
source"request" | "client_invite"requiredrequested_atstringrequireddecided_atstring | nullrequiredended_atstring | nullrequiredend_reason"owner" | "partner" | "partner_suspended" | "closure" | "firm_deleted" | "expired"requiredfirst_used_atstring | nullrequiredlast_used_atstring | nullrequiredpeopleobject[]requiredWho at the firm can open the company (each recorded by name).
3 fields
namestringrequiredrole"owner" | "staff"requiredlast_opened_atstring | nullrequired
pendingintegerrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/platform/partner_access.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/partner_access.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": {
"grants": [
{
"id": "f1:o1",
"firm": {
"id": "f1",
"name": "Contas & Co",
"country": "PT",
"city": "Braga",
"website": "https://contas.pt",
"registration": {
"scheme": "occ",
"number": "12345",
"label": null
},
"status": "approved"
},
"type": "accountant",
"role": "Accountant",
"extras_allowed": [
"private",
"documents",
"checklists"
],
"never": [
"settings_billing",
"members_roles",
"credentials",
"closure",
"any_change"
],
"expires_at": null,
"access_days": null,
"status": "requested",
"extras": [],
"fixed": [
"people",
"pay",
"payroll",
"time_off",
"accountant_documents"
],
"message": "We run your payroll from next month.",
"source": "request",
"requested_at": "2026-10-11T09:00:00.000Z",
"decided_at": null,
"ended_at": null,
"end_reason": null,
"first_used_at": null,
"last_used_at": null,
"people": [
{
"name": "Ana Reis",
"role": "owner",
"last_opened_at": null
},
{
"name": "Bruno Costa",
"role": "staff",
"last_opened_at": null
}
]
}
],
"pending": 1
}
}One firm's partner access#
POST/v1/platform/partner_access.getRead
One firm's partner access: the consent page's facts (who the firm is, who at it can open the company, exactly what it can see and do, its message) and its state. Owners only.
- Who can call it
- Manage key owner
- MCP tool
platform_partner_access_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
grant_idstringrequiredA grant id from
platform_partner_access_list.1–140 characters.
Returns
20 fields
idstringrequiredfirmobjectrequired7 fields
idstringrequirednamestringrequiredcountrystringrequiredcitystring | nullrequiredwebsitestring | nullrequiredregistrationobject | nullrequired3 fields
scheme"occ" | "colegio" | "tax_id" | "other"requirednumberstringrequiredlabelstring | nullrequired
status"pending" | "approved" | "rejected" | "suspended"required
type"accountant" | "hr_consultant" | "implementation"requiredThe firm's partner type, which sets its role: Accountant (read-only), HR partner or Implementation partner (setup, for a limited time).
rolestringrequiredThe role the firm's people get in the company.
status"requested" | "active" | "expired" | "declined" | "revoked"requiredextras_allowed"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner may add for this type.
neverstring (enum)[]requiredWhat this role can never do.
One of:
settings_billing,members_roles,credentials,closure,any_change,legal_entities,sign_in,pay_private,webhooks_exports.expires_atstring | nullrequiredImplementation partners: when the access ends by itself (renewed by a new request).
access_daysinteger | nullrequiredextras"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner added to the fixed access: private (contact, address and payroll identifiers), documents (every company and person document), checklists.
fixedstring (enum)[]requiredWhat the role always covers. Accountant (read-only): people, pay, payroll, time_off (who is away; absences in payroll exports), accountant_documents. HR partner: people_edit, private_edit, structure_edit, positions_edit, checklists_edit,
documents_edit, time_off_settings. Implementation partner: people_view, structure_edit, setup_edit (imports and integrations setup), time_off_settings.One of:
people,pay,payroll,time_off,accountant_documents,people_edit,private_edit,structure_edit,positions_edit,checklists_edit,documents_edit,time_off_settings,people_view,setup_edit.messagestring | nullrequiredThe firm's note to the owner (in the app only).
source"request" | "client_invite"requiredrequested_atstringrequireddecided_atstring | nullrequiredended_atstring | nullrequiredend_reason"owner" | "partner" | "partner_suspended" | "closure" | "firm_deleted" | "expired"requiredfirst_used_atstring | nullrequiredlast_used_atstring | nullrequiredpeopleobject[]requiredWho at the firm can open the company (each recorded by name).
3 fields
namestringrequiredrole"owner" | "staff"requiredlast_opened_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"grant_id":"f1:o1"}'const res = await fetch('https://api.bizisy.com/v1/platform/partner_access.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"grant_id": "f1:o1"
}),
});
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/partner_access.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"grant_id": "f1:o1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "f1:o1",
"firm": {
"id": "f1",
"name": "Contas & Co",
"country": "PT",
"city": "Braga",
"website": "https://contas.pt",
"registration": {
"scheme": "occ",
"number": "12345",
"label": null
},
"status": "approved"
},
"type": "accountant",
"role": "Accountant",
"extras_allowed": [
"private",
"documents",
"checklists"
],
"never": [
"settings_billing",
"members_roles",
"credentials",
"closure",
"any_change"
],
"expires_at": null,
"access_days": null,
"status": "requested",
"extras": [],
"fixed": [
"people",
"pay",
"payroll",
"time_off",
"accountant_documents"
],
"message": "We run your payroll from next month.",
"source": "request",
"requested_at": "2026-10-11T09:00:00.000Z",
"decided_at": null,
"ended_at": null,
"end_reason": null,
"first_used_at": null,
"last_used_at": null,
"people": [
{
"name": "Ana Reis",
"role": "owner",
"last_opened_at": null
},
{
"name": "Bruno Costa",
"role": "staff",
"last_opened_at": null
}
]
}
}Approve or decline a partner's access#
POST/v1/platform/partner_access.decideWrite
Approves or declines a partner firm's request for access (owners, in the app). Approving gives the firm's people its type's role: Accountant (people and jobs, pay and payroll, payroll exports, time off and documents shared with the accountant, read-only; extras: private, documents, checklists), HR partner (changes people, jobs, private details, teams, positions, checklists, documents and time off settings, with approval rules applying; extra: pay) or Implementation partner (setup: structure, imports, integrations setup and time off settings, people at view; for access_days days, default 30, at most 90). None covers settings, billing, members, roles or credentials. The firm's owners and the company's owners get an email.
- Who can call it
- Manage key owner
- MCP tool
platform_partner_access_decideon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
grant_idstringrequiredA grant id from
platform_partner_access_list.1–140 characters.
decision"approve" | "decline"requiredextras"private" | "documents" | "checklists" | "pay"[]Up to 4 items.
access_daysintegerImplementation partners: how long the access lasts (default 30 days).
From 1 to 90.
Returns
20 fields
idstringrequiredfirmobjectrequired7 fields
idstringrequirednamestringrequiredcountrystringrequiredcitystring | nullrequiredwebsitestring | nullrequiredregistrationobject | nullrequired3 fields
scheme"occ" | "colegio" | "tax_id" | "other"requirednumberstringrequiredlabelstring | nullrequired
status"pending" | "approved" | "rejected" | "suspended"required
type"accountant" | "hr_consultant" | "implementation"requiredThe firm's partner type, which sets its role: Accountant (read-only), HR partner or Implementation partner (setup, for a limited time).
rolestringrequiredThe role the firm's people get in the company.
status"requested" | "active" | "expired" | "declined" | "revoked"requiredextras_allowed"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner may add for this type.
neverstring (enum)[]requiredWhat this role can never do.
One of:
settings_billing,members_roles,credentials,closure,any_change,legal_entities,sign_in,pay_private,webhooks_exports.expires_atstring | nullrequiredImplementation partners: when the access ends by itself (renewed by a new request).
access_daysinteger | nullrequiredextras"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner added to the fixed access: private (contact, address and payroll identifiers), documents (every company and person document), checklists.
fixedstring (enum)[]requiredWhat the role always covers. Accountant (read-only): people, pay, payroll, time_off (who is away; absences in payroll exports), accountant_documents. HR partner: people_edit, private_edit, structure_edit, positions_edit, checklists_edit,
documents_edit, time_off_settings. Implementation partner: people_view, structure_edit, setup_edit (imports and integrations setup), time_off_settings.One of:
people,pay,payroll,time_off,accountant_documents,people_edit,private_edit,structure_edit,positions_edit,checklists_edit,documents_edit,time_off_settings,people_view,setup_edit.messagestring | nullrequiredThe firm's note to the owner (in the app only).
source"request" | "client_invite"requiredrequested_atstringrequireddecided_atstring | nullrequiredended_atstring | nullrequiredend_reason"owner" | "partner" | "partner_suspended" | "closure" | "firm_deleted" | "expired"requiredfirst_used_atstring | nullrequiredlast_used_atstring | nullrequiredpeopleobject[]requiredWho at the firm can open the company (each recorded by name).
3 fields
namestringrequiredrole"owner" | "staff"requiredlast_opened_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.decide \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"grant_id": "f1:o1",
"decision": "approve",
"extras": [
"private",
"documents"
]
}'const res = await fetch('https://api.bizisy.com/v1/platform/partner_access.decide', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"grant_id": "f1:o1",
"decision": "approve",
"extras": [
"private",
"documents"
]
}),
});
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/partner_access.decide",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"grant_id": "f1:o1",
"decision": "approve",
"extras": [
"private",
"documents",
],
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "f1:o1",
"firm": {
"id": "f1",
"name": "Contas & Co",
"country": "PT",
"city": "Braga",
"website": "https://contas.pt",
"registration": {
"scheme": "occ",
"number": "12345",
"label": null
},
"status": "approved"
},
"type": "accountant",
"role": "Accountant",
"extras_allowed": [
"private",
"documents",
"checklists"
],
"never": [
"settings_billing",
"members_roles",
"credentials",
"closure",
"any_change"
],
"expires_at": null,
"access_days": null,
"status": "active",
"extras": [],
"fixed": [
"people",
"pay",
"payroll",
"time_off",
"accountant_documents"
],
"message": null,
"source": "request",
"requested_at": "2026-10-11T09:00:00.000Z",
"decided_at": "2026-10-11T10:00:00.000Z",
"ended_at": null,
"end_reason": null,
"first_used_at": null,
"last_used_at": null,
"people": [
{
"name": "Ana Reis",
"role": "owner",
"last_opened_at": null
},
{
"name": "Bruno Costa",
"role": "staff",
"last_opened_at": null
}
]
}
}Change what your partner can see#
POST/v1/platform/partner_access.updateWrite
Changes the extras of an active partner access (owners, in the app): private (contact, address and payroll identifiers), documents (every document), checklists. The fixed areas stay. Takes effect on the firm's next request.
- Who can call it
- Manage key owner
- MCP tool
platform_partner_access_updateon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
grant_idstringrequiredA grant id from
platform_partner_access_list.1–140 characters.
extras"private" | "documents" | "checklists" | "pay"[]Up to 4 items.
Returns
20 fields
idstringrequiredfirmobjectrequired7 fields
idstringrequirednamestringrequiredcountrystringrequiredcitystring | nullrequiredwebsitestring | nullrequiredregistrationobject | nullrequired3 fields
scheme"occ" | "colegio" | "tax_id" | "other"requirednumberstringrequiredlabelstring | nullrequired
status"pending" | "approved" | "rejected" | "suspended"required
type"accountant" | "hr_consultant" | "implementation"requiredThe firm's partner type, which sets its role: Accountant (read-only), HR partner or Implementation partner (setup, for a limited time).
rolestringrequiredThe role the firm's people get in the company.
status"requested" | "active" | "expired" | "declined" | "revoked"requiredextras_allowed"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner may add for this type.
neverstring (enum)[]requiredWhat this role can never do.
One of:
settings_billing,members_roles,credentials,closure,any_change,legal_entities,sign_in,pay_private,webhooks_exports.expires_atstring | nullrequiredImplementation partners: when the access ends by itself (renewed by a new request).
access_daysinteger | nullrequiredextras"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner added to the fixed access: private (contact, address and payroll identifiers), documents (every company and person document), checklists.
fixedstring (enum)[]requiredWhat the role always covers. Accountant (read-only): people, pay, payroll, time_off (who is away; absences in payroll exports), accountant_documents. HR partner: people_edit, private_edit, structure_edit, positions_edit, checklists_edit,
documents_edit, time_off_settings. Implementation partner: people_view, structure_edit, setup_edit (imports and integrations setup), time_off_settings.One of:
people,pay,payroll,time_off,accountant_documents,people_edit,private_edit,structure_edit,positions_edit,checklists_edit,documents_edit,time_off_settings,people_view,setup_edit.messagestring | nullrequiredThe firm's note to the owner (in the app only).
source"request" | "client_invite"requiredrequested_atstringrequireddecided_atstring | nullrequiredended_atstring | nullrequiredend_reason"owner" | "partner" | "partner_suspended" | "closure" | "firm_deleted" | "expired"requiredfirst_used_atstring | nullrequiredlast_used_atstring | nullrequiredpeopleobject[]requiredWho at the firm can open the company (each recorded by name).
3 fields
namestringrequiredrole"owner" | "staff"requiredlast_opened_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"grant_id":"f1:o1","extras":["checklists"]}'const res = await fetch('https://api.bizisy.com/v1/platform/partner_access.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"grant_id": "f1:o1",
"extras": [
"checklists"
]
}),
});
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/partner_access.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"grant_id": "f1:o1",
"extras": [
"checklists",
],
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "f1:o1",
"firm": {
"id": "f1",
"name": "Contas & Co",
"country": "PT",
"city": "Braga",
"website": "https://contas.pt",
"registration": {
"scheme": "occ",
"number": "12345",
"label": null
},
"status": "approved"
},
"type": "accountant",
"role": "Accountant",
"extras_allowed": [
"private",
"documents",
"checklists"
],
"never": [
"settings_billing",
"members_roles",
"credentials",
"closure",
"any_change"
],
"expires_at": null,
"access_days": null,
"status": "active",
"extras": [
"checklists"
],
"fixed": [
"people",
"pay",
"payroll",
"time_off",
"accountant_documents"
],
"message": null,
"source": "request",
"requested_at": "2026-10-11T09:00:00.000Z",
"decided_at": null,
"ended_at": null,
"end_reason": null,
"first_used_at": null,
"last_used_at": null,
"people": [
{
"name": "Ana Reis",
"role": "owner",
"last_opened_at": null
},
{
"name": "Bruno Costa",
"role": "staff",
"last_opened_at": null
}
]
}
}Revoke partner access#
POST/v1/platform/partner_access.revokeDestructive
Ends a firm's partner access now, or withdraws a request (owners, in the app): its people are signed out of the company at once and can no longer open it. What they did stays in Activity. The firm's owners get an email. The firm can ask again later.
- Who can call it
- Manage key owner
- MCP tool
platform_partner_access_revokeon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
grant_idstringrequiredA grant id from
platform_partner_access_list.1–140 characters.
Returns
20 fields
idstringrequiredfirmobjectrequired7 fields
idstringrequirednamestringrequiredcountrystringrequiredcitystring | nullrequiredwebsitestring | nullrequiredregistrationobject | nullrequired3 fields
scheme"occ" | "colegio" | "tax_id" | "other"requirednumberstringrequiredlabelstring | nullrequired
status"pending" | "approved" | "rejected" | "suspended"required
type"accountant" | "hr_consultant" | "implementation"requiredThe firm's partner type, which sets its role: Accountant (read-only), HR partner or Implementation partner (setup, for a limited time).
rolestringrequiredThe role the firm's people get in the company.
status"requested" | "active" | "expired" | "declined" | "revoked"requiredextras_allowed"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner may add for this type.
neverstring (enum)[]requiredWhat this role can never do.
One of:
settings_billing,members_roles,credentials,closure,any_change,legal_entities,sign_in,pay_private,webhooks_exports.expires_atstring | nullrequiredImplementation partners: when the access ends by itself (renewed by a new request).
access_daysinteger | nullrequiredextras"private" | "documents" | "checklists" | "pay"[]requiredWhat the owner added to the fixed access: private (contact, address and payroll identifiers), documents (every company and person document), checklists.
fixedstring (enum)[]requiredWhat the role always covers. Accountant (read-only): people, pay, payroll, time_off (who is away; absences in payroll exports), accountant_documents. HR partner: people_edit, private_edit, structure_edit, positions_edit, checklists_edit,
documents_edit, time_off_settings. Implementation partner: people_view, structure_edit, setup_edit (imports and integrations setup), time_off_settings.One of:
people,pay,payroll,time_off,accountant_documents,people_edit,private_edit,structure_edit,positions_edit,checklists_edit,documents_edit,time_off_settings,people_view,setup_edit.messagestring | nullrequiredThe firm's note to the owner (in the app only).
source"request" | "client_invite"requiredrequested_atstringrequireddecided_atstring | nullrequiredended_atstring | nullrequiredend_reason"owner" | "partner" | "partner_suspended" | "closure" | "firm_deleted" | "expired"requiredfirst_used_atstring | nullrequiredlast_used_atstring | nullrequiredpeopleobject[]requiredWho at the firm can open the company (each recorded by name).
3 fields
namestringrequiredrole"owner" | "staff"requiredlast_opened_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.revoke \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"grant_id":"f1:o1"}'const res = await fetch('https://api.bizisy.com/v1/platform/partner_access.revoke', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"grant_id": "f1:o1"
}),
});
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/partner_access.revoke",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"grant_id": "f1:o1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "f1:o1",
"firm": {
"id": "f1",
"name": "Contas & Co",
"country": "PT",
"city": "Braga",
"website": "https://contas.pt",
"registration": {
"scheme": "occ",
"number": "12345",
"label": null
},
"status": "approved"
},
"type": "accountant",
"role": "Accountant",
"extras_allowed": [
"private",
"documents",
"checklists"
],
"never": [
"settings_billing",
"members_roles",
"credentials",
"closure",
"any_change"
],
"expires_at": null,
"access_days": null,
"status": "revoked",
"extras": [],
"fixed": [
"people",
"pay",
"payroll",
"time_off",
"accountant_documents"
],
"message": null,
"source": "request",
"requested_at": "2026-10-11T09:00:00.000Z",
"decided_at": null,
"ended_at": "2026-10-12T10:00:00.000Z",
"end_reason": "owner",
"first_used_at": null,
"last_used_at": null,
"people": []
}
}Opened the company from the partner console#
POST/v1/platform/partner_access.openedWrite
Records in Activity that a firm's person opened the company from the partner console (Manage calls it once per such session). Only for a session opened through partner access.
- Who can call it
- MCP tool
platform_partner_access_openedon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
No input: send {}.
Returns
recordedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/platform/partner_access.opened \
-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/partner_access.opened', {
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/partner_access.opened",
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": {
"recorded": true
}
}Something missing or wrong on this page? Write to hello@bizisy.com.