API reference
Talent profiles
A person's talent profile: history in the company and courses done (from the records), the skills that count, and the education, certificates and earlier experience the person or HR adds (HR verifies in the app). API keys and AI apps see their own profile without certificate numbers and others only when shown to colleagues; who sees a profile is the person's choice in the app.
6 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
A talent profile#
POST/v1/talent/profile.getRead
A person's talent profile (default: yours): headline and about, history in the company (titles and teams by month, from the records), courses done (confirmed training), the skills that count, and what the person or HR added: education (qualification, institution, ISCED 2011 level, ISCED-F 2013 field, done / in progress / paused, years), certificates and licences, experience before joining; with sources and HR's verification. Who: the person; owners, admins and HR; the person's managers; colleagues only when the person chose "Show my profile to colleagues" (about, experience and certificate numbers never). API keys and AI apps see their own profile without certificate numbers, and others only as colleagues do. Not found for anyone else (the same answer as an unknown person). When the company has profiles off, only your own shows (empty, settings.on false).
- Who can call it
- Manage key owner admin hr
Me key owner admin hr member - Keys and apps
- Your own profile without certificate numbers; someone else's only when they show it to colleagues, as colleagues see it.
- MCP tool
talent_profile_geton My Workplace, HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
person_idstringWhose; default you.
1–200 characters.
Returns
16 fields
personobjectrequired5 fields
idstringrequirednamestringrequiredtitlestring | nullrequiredunitstring | nullrequiredlocationstring | nullrequired
relation"self" | "hr" | "manager" | "colleague"requiredHow the caller sees it: their own, HR, a manager in the chain, or as colleagues see it.
settingsobjectrequired2 fields
onbooleanrequiredcolleagues_allowedbooleanrequired
visibility"hr_managers" | "colleagues"requiredhr_managers (default) or colleagues; for the person and HR only.
headlinestringrequiredaboutstring | nullrequirednull for colleagues.
historyobject[]requiredTitles and teams in the company by month (from the records; nobody types them).
4 fields
titlestring | nullrequiredunitstring | nullrequiredfromstringrequiredtostring | nullrequired
coursesobject[]requiredConfirmed training records; colleagues see the title and year only.
4 fields
titlestringrequiredproviderstring | nullrequiredyearintegerrequiredendstring | nullrequired
skillsobject[]requiredThe level that counts per skill (manager, else training or accepted inferred, else self).
4 fields
idstringrequirednamestringrequiredcategorystringrequiredlevelintegerrequired
educationobject[]required11 fields
idstringrequiredsource"self" | "hr" | "cv" | "linkedin"requiredverifiedobject | nullrequired2 fields
byobject | nullrequired2 fields
idstringrequirednamestringrequired
atstringrequired
updated_atstringrequiredqualificationstringrequiredinstitutionstring | nullrequiredisced_levelinteger | nullrequiredisced_fieldstring | nullrequiredstatus"done" | "in_progress" | "paused"requiredstart_yearinteger | nullrequiredend_yearinteger | nullrequired
credentialsobject[]required9 fields
idstringrequiredsource"self" | "hr" | "cv" | "linkedin"requiredverifiedobject | nullrequired2 fields
byobject | nullrequired2 fields
idstringrequirednamestringrequired
atstringrequired
updated_atstringrequirednamestringrequiredissuerstring | nullrequiredissuedstring | nullrequiredexpiresstring | nullrequiredcredential_idstring | nullrequiredPrivate: only for the person and HR in the app; null for everyone else.
experienceobject[]requiredEmpty for colleagues.
9 fields
idstringrequiredsource"self" | "hr" | "cv" | "linkedin"requiredverifiedobject | nullrequired2 fields
byobject | nullrequired2 fields
idstringrequirednamestringrequired
atstringrequired
updated_atstringrequiredemployerstringrequiredrolestringrequiredfromstring | nullrequiredtostring | nullrequiredsummarystring | nullrequired
can_editbooleanrequiredcan_verifybooleanrequiredpromptbooleanrequiredThe person has not answered "Show my profile to colleagues?" yet (Me shows the one-time prompt).
limitsobjectrequired3 fields
educationintegerrequiredcredentialsintegerrequiredexperienceintegerrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"person_id":"p1"}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"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
import requests
res = requests.post(
"https://api.bizisy.com/v1/talent/profile.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"person_id": "p1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"person": {
"id": "p1",
"name": "Rita Silva",
"title": "Accounts assistant",
"unit": "Finance",
"location": "Porto"
},
"relation": "self",
"settings": {
"on": true,
"colleagues_allowed": true
},
"visibility": "hr_managers",
"headline": "Accounts assistant studying accounting",
"about": "I like numbers.",
"history": [
{
"title": "Customer care agent",
"unit": "Care",
"from": "2022-03",
"to": "2024-01"
},
{
"title": "Accounts assistant",
"unit": "Finance",
"from": "2024-02",
"to": null
}
],
"courses": [
{
"title": "Excel advanced",
"provider": "Acme Academy",
"year": 2025,
"end": "2025-05-02"
}
],
"skills": [
{
"id": "s1",
"name": "Accounting",
"category": "Finance",
"level": 3
}
],
"education": [
{
"id": "e1",
"source": "self",
"verified": {
"by": {
"id": "p9",
"name": "Hugo Silva"
},
"at": "2026-11-16T10:00:00.000Z"
},
"updated_at": "2026-11-16T10:00:00.000Z",
"qualification": "Licenciatura em Contabilidade",
"institution": "ISCAP",
"isced_level": 6,
"isced_field": "0411",
"status": "in_progress",
"start_year": 2023,
"end_year": 2027
}
],
"credentials": [
{
"id": "e2",
"source": "hr",
"verified": null,
"updated_at": "2026-11-16T10:00:00.000Z",
"name": "Certified Scrum Master",
"issuer": "Scrum Alliance",
"issued": "2025-03",
"expires": null,
"credential_id": "CSM-123456"
}
],
"experience": [
{
"id": "e3",
"source": "self",
"verified": null,
"updated_at": "2026-11-16T10:00:00.000Z",
"employer": "Padaria Lda",
"role": "Bookkeeper",
"from": "2019-01",
"to": "2022-02",
"summary": null
}
],
"can_edit": true,
"can_verify": false,
"prompt": true,
"limits": {
"education": 15,
"credentials": 30,
"experience": 20
}
}
}Change my talent profile#
POST/v1/talent/profile.updateWrite
Changes your own talent profile (only what is given): headline (≤ 120 characters), about (≤ 1,000), visibility (hr_managers: owners, admins, HR and your managers, the default; colleagues: also everyone in the company, without about, earlier experience or certificate numbers; only when the company allows it), prompted true (you answered the one-time "Show my profile to colleagues?" prompt). Takes effect at once. Your own profile only, signed in to Bizisy (who sees you is your choice, never an AI's).
- Who can call it
- Me key owner admin hr member
- MCP tool
talent_profile_updateon My Workplace- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
headlinestringUp to 120 characters.
aboutstringUp to 1000 characters.
visibility"hr_managers" | "colleagues"promptedtrue
Returns
person_idstringrequiredheadlinestringrequiredaboutstringrequiredvisibility"hr_managers" | "colleagues"requiredpromptedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"about":"Hi","visibility":"colleagues","prompted":true}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"about": "Hi",
"visibility": "colleagues",
"prompted": 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/talent/profile.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"about": "Hi",
"visibility": "colleagues",
"prompted": True,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"person_id": "p1",
"headline": "Studying accounting",
"about": "Hi",
"visibility": "colleagues",
"prompted": true
}
}Add to a talent profile#
POST/v1/talent/profile.entries.addWrite
Adds an entry to a talent profile (default: yours): Education (qualification, institution, ISCED 2011 level 1–8, ISCED-F 2013 narrow field such as 0411 Accounting and taxation, status done / in_progress / paused, start and end year: the expected end while in progress), a certificate or licence (name, issuer, issued and expires as YYYY-MM, credential_id: the number, private and never over an API key or AI app), or experience before joining (employer, role, from, to, summary ≤ 500). Up to 15 education, 30 certificates and 20 experience entries a person. The person adds their own; owners, admins and HR anyone's (shown as added by HR). Over an API key or AI app, someone else's profile only when it is shown to colleagues (otherwise not found, as for talent_profile_get). Managers can't (they set skill levels). Refused while the company has profiles off.
- Who can call it
- Manage key owner admin hr
Me key owner admin hr member - Keys and apps
- Certificate numbers (credential_id) are refused: the person adds them in the app. Someone else's profile only when it is shown to colleagues (otherwise not found).
- MCP tool
talent_profile_entries_addon My Workplace, 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
person_idstringWhose; default you.
1–200 characters.
entryobjectrequired20 fields (one of several shapes)
Option 1
kind"education"requiredqualificationstringrequiredThe degree, diploma or course as it is called, e.g. "Licenciatura em Contabilidade".
1–160 characters.
institutionstring | nullUp to 160 characters.
isced_levelinteger | nullISCED 2011: 3 upper secondary, 4 post-secondary, 5 short-cycle tertiary, 6 bachelor's, 7 master's, 8 doctoral.
isced_fieldstring | nullPattern
^\d{4}$.status"done" | "in_progress" | "paused"requireddone, in_progress (still studying; give end_year as the expected end) or paused.
start_yearinteger | nullFrom 1950 to 2100.
end_yearinteger | nullFrom 1950 to 2100.
Option 2
kind"credential"requirednamestringrequiredE.g. "Certified Scrum Master" or "Forklift licence".
1–160 characters.
issuerstring | nullUp to 160 characters.
issuedstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.expiresstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.credential_idstring | nullThe certificate number (private: the person and HR only). Never over an API key or AI app.
Up to 100 characters.
Option 3
kind"experience"requiredemployerstringrequired1–160 characters.
rolestringrequired1–160 characters.
fromstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.tostring | nullnull: until they joined.
Pattern
^\d{4}-(0[1-9]|1[0-2])$.summarystring | nullUp to 500 characters.
Returns
idstringrequiredperson_idstringrequiredkind"education" | "credential" | "experience"requiredby_selfbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.entries.add \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"person_id": "p1",
"entry": {
"kind": "education",
"qualification": "MSc Finance",
"institution": "Nova SBE",
"isced_level": 7,
"isced_field": "0412",
"status": "done",
"start_year": 2018,
"end_year": 2020
}
}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.entries.add', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"person_id": "p1",
"entry": {
"kind": "education",
"qualification": "MSc Finance",
"institution": "Nova SBE",
"isced_level": 7,
"isced_field": "0412",
"status": "done",
"start_year": 2018,
"end_year": 2020
}
}),
});
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/talent/profile.entries.add",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"person_id": "p1",
"entry": {
"kind": "education",
"qualification": "MSc Finance",
"institution": "Nova SBE",
"isced_level": 7,
"isced_field": "0412",
"status": "done",
"start_year": 2018,
"end_year": 2020,
},
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "e1",
"person_id": "p1",
"kind": "education",
"by_self": true
}
}Change a talent profile entry#
POST/v1/talent/profile.entries.updateWrite
Replaces an entry's fields (entry_id from talent_profile_get; the kind stays): Education (qualification, institution, ISCED 2011 level 1–8, ISCED-F 2013 narrow field such as 0411 Accounting and taxation, status done / in_progress / paused, start and end year: the expected end while in progress), a certificate or licence (name, issuer, issued and expires as YYYY-MM, credential_id: the number, private and never over an API key or AI app), or experience before joining (employer, role, from, to, summary ≤ 500). Up to 15 education, 30 certificates and 20 experience entries a person. A change clears HR's verification. Over an API key or AI app a certificate's number is kept as it is (it can't be sent). The person and owners, admins and HR.
- Who can call it
- Manage key owner admin hr
Me key owner admin hr member - Keys and apps
- Certificate numbers (credential_id) are refused; a stored number is kept as it is. Someone else's profile only when it is shown to colleagues.
- MCP tool
talent_profile_entries_updateon My Workplace, 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
entry_idstringrequired1–200 characters.
entryobjectrequired20 fields (one of several shapes)
Option 1
kind"education"requiredqualificationstringrequiredThe degree, diploma or course as it is called, e.g. "Licenciatura em Contabilidade".
1–160 characters.
institutionstring | nullUp to 160 characters.
isced_levelinteger | nullISCED 2011: 3 upper secondary, 4 post-secondary, 5 short-cycle tertiary, 6 bachelor's, 7 master's, 8 doctoral.
isced_fieldstring | nullPattern
^\d{4}$.status"done" | "in_progress" | "paused"requireddone, in_progress (still studying; give end_year as the expected end) or paused.
start_yearinteger | nullFrom 1950 to 2100.
end_yearinteger | nullFrom 1950 to 2100.
Option 2
kind"credential"requirednamestringrequiredE.g. "Certified Scrum Master" or "Forklift licence".
1–160 characters.
issuerstring | nullUp to 160 characters.
issuedstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.expiresstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.credential_idstring | nullThe certificate number (private: the person and HR only). Never over an API key or AI app.
Up to 100 characters.
Option 3
kind"experience"requiredemployerstringrequired1–160 characters.
rolestringrequired1–160 characters.
fromstring | nullPattern
^\d{4}-(0[1-9]|1[0-2])$.tostring | nullnull: until they joined.
Pattern
^\d{4}-(0[1-9]|1[0-2])$.summarystring | nullUp to 500 characters.
Returns
idstringrequiredperson_idstringrequiredkind"education" | "credential" | "experience"requiredby_selfbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.entries.update \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"entry_id": "e1",
"entry": {
"kind": "education",
"qualification": "Licenciatura em Contabilidade",
"status": "done",
"end_year": 2026
}
}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.entries.update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"entry_id": "e1",
"entry": {
"kind": "education",
"qualification": "Licenciatura em Contabilidade",
"status": "done",
"end_year": 2026
}
}),
});
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/talent/profile.entries.update",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"entry_id": "e1",
"entry": {
"kind": "education",
"qualification": "Licenciatura em Contabilidade",
"status": "done",
"end_year": 2026,
},
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "e1",
"person_id": "p1",
"kind": "education",
"by_self": true
}
}Remove a talent profile entry#
POST/v1/talent/profile.entries.removeWrite
Removes an entry from a talent profile (entry_id from talent_profile_get). The person and owners, admins and HR.
- Who can call it
- Manage key owner admin hr
Me key owner admin hr member - MCP tool
talent_profile_entries_removeon My Workplace, 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
entry_idstringrequired1–200 characters.
Returns
idstringrequiredperson_idstringrequiredremovedtruerequiredby_selfbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.entries.remove \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"entry_id":"e1"}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.entries.remove', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"entry_id": "e1"
}),
});
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/talent/profile.entries.remove",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"entry_id": "e1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "e1",
"person_id": "p1",
"removed": true,
"by_self": true
}
}Verify a talent profile entry#
POST/v1/talent/profile.entries.verifyWrite
Marks an entry as verified (verified false takes it back): HR saw the evidence, for example the diploma. The profile shows a Verified badge with who and when; changing the entry clears it. Owners, admins and HR, signed in to Bizisy, never on their own profile.
- Who can call it
- Manage key owner admin hr
- MCP tool
talent_profile_entries_verifyon 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
entry_idstringrequired1–200 characters.
verifiedbooleanDefault
true.
Returns
idstringrequiredperson_idstringrequiredverifiedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/talent/profile.entries.verify \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"entry_id":"e1","verified":false}'const res = await fetch('https://api.bizisy.com/v1/talent/profile.entries.verify', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"entry_id": "e1",
"verified": 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/talent/profile.entries.verify",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"entry_id": "e1",
"verified": False,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "e1",
"person_id": "p1",
"verified": false
}
}Something missing or wrong on this page? Write to hello@bizisy.com.