API reference
My surveys
The surveys sent to a person and their saved answers (answering is in the app).
12 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
My surveys#
POST/v1/surveys/me.listRead
The surveys sent to me: those open (new, started or answered) and the closed ones I answered, newest first, each with its title in my language. For anyone in the company, about themselves.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
languagestringMy language (titles in it when the survey has it).
Pattern
^[a-z]{2}(-[A-Z]{2})?$.
Returns
itemsobject[]required9 fields
idstringrequiredtitlestringrequiredThe cover title, in my language.
mode"named" | "confidential" | "anonymous"requiredstatus"open" | "closed"requiredclose_atstring | nullrequiredsent_atstringrequiredstate"new" | "started" | "answered"requiredprogressnumberrequired0–1 of the questions on my way through it.
answered_atstring | nullrequired
to_answerintegerrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"language":"pt-PT"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
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
import requests
res = requests.post(
"https://api.bizisy.com/v1/surveys/me.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"language": "pt-PT",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "s1",
"title": "Team pulse",
"mode": "confidential",
"status": "open",
"close_at": "2026-11-27T18:00:00.000Z",
"sent_at": "2026-11-13T09:00:00.000Z",
"state": "started",
"progress": 0.33,
"answered_at": null
}
],
"to_answer": 1
}
}Open a survey sent to me#
POST/v1/surveys/me.getRead
A survey sent to me, to answer it: its definition (with every translation; language is the one picked for me), what is known about me for piping (first name, team, location), my saved answers (a draft I can resume, or what I submitted), the choices already full, and the locations and people the pickers offer. not_found for surveys not sent to me. For anyone in the company, about themselves.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_geton My Workplace- Method
POSTwith a JSON body only (an input field carries a secret)
Input
survey_idstringrequired1–64 characters.
languagestringPattern
^[a-z]{2}(-[A-Z]{2})?$.tokenstringAnonymous surveys: the one-time token this device keeps.
20–100 characters.
Returns
14 fields
token_issuedbooleanrequiredAnonymous surveys: a token was already given out for me (on this or another device).
idstringrequiredtitlestringrequiredmode"named" | "confidential" | "anonymous"requiredstatus"open" | "closed"requiredclose_atstring | nullrequireddefinitionobjectrequiredThe survey: pages of questions (types: single, multi, dropdown, nps 0–10, likert 5/7, star, emoji, slider, ranking, matrix, short_text, long_text, number, date, yes_no, people (named surveys only), location, statement, consent), show_if conditions, jumps after a page (to a later page or "end"), piping in texts and choices ({{answer:<question id>}}, {{person:first_name|team|location}}, {{var:<variable id>}}), variables fed by score_into, outcomes shown at the end, translations per language keyed like "q:<question id>:title" or "c:<question id>:<choice id>".
12 fields
languagestringrequiredPattern
^[a-z]{2}(-[A-Z]{2})?$.languagesstring[]requiredUp to 10 items. Pattern
^[a-z]{2}(-[A-Z]{2})?$.translationsobjectrequiredcoverobjectrequired3 fields
showbooleanrequiredtitlestringrequiredUp to 300 characters.
bodystring | nullUp to 5000 characters.
thanksobjectrequired5 fields
titlestringrequiredUp to 300 characters.
bodystring | nullUp to 5000 characters.
link_urlstring | nullUp to 500 characters. Pattern
^https:\/\/[^\s]+$.link_labelstring | nullUp to 80 characters.
redirect_urlstring | nullUp to 500 characters. Pattern
^https:\/\/[^\s]+$.
layout"one" | "page"requiredprogressbooleanrequiredlogobooleanrequiredthemeobjectHow the answering screen looks (the Design tab).
7 fields
palettestring (enum)company (Settings → Appearance) or one of the palettes.
One of:
company,emerald,violet,indigo,ocean,amber,rose,graphite,terracotta.surface"plain" | "soft" | "tinted" | "dark"The page behind the questions: plain, soft, tinted or dark.
font"default" | "friendly" | "display" | "serif"buttons"rounded" | "pill" | "square"imagestring | nullA background image id from surveys_design_image_upload.
Pattern
^[0-9a-z]{26}$.image_dimintegerHow much the image is veiled under the text, 45–85 (%; default 65): the text stays readable.
From 45 to 85.
brandingboolean"Powered by Bizisy" at the bottom (default true).
pagesobject[]required1–50 items.
6 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.titlestring | nullUp to 300 characters.
descriptionstring | nullUp to 2000 characters.
questionsobject[]requiredUp to 200 items.
22 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.typestring (enum)requiredOne of:
single,multi,dropdown,nps,likert,star,emoji,slider,ranking,matrix,short_text,long_text,number,date,yes_no,people,location,statement,consent.titlestringrequiredUp to 1000 characters.
descriptionstring | nullUp to 2000 characters.
requiredbooleanrequired_messagestring | nullUp to 200 characters.
choicesobject[]Up to 100 items.
4 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.labelstringrequiredUp to 500 characters.
scorenumber | nullquotainteger | nullFrom 1 to 100000.
otherbooleanrandomizebooleanmax_picksinteger | nullFrom 1 to 100.
points5 | 7minnumber | nullmaxnumber | nullstepnumber | nullAt least 0.
low_labelstring | nullUp to 80 characters.
high_labelstring | nullUp to 80 characters.
rowsobject[]Up to 100 items.
4 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.labelstringrequiredUp to 500 characters.
scorenumber | nullquotainteger | nullFrom 1 to 100000.
max_lengthinteger | nullFrom 1 to 5000.
show_ifobject | null2 fields
match"all" | "any"requiredrulesobject[]requiredUp to 20 items.
score_intoobject | null2 fields
variablestringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.weightnumber
library_idstring | nullThe library item it was copied from (surveys_library_list): rounds and trends compare by it.
Pattern
^lib\.[a-z]+\.[a-z]+$.driverstring | nullThe engagement driver it measures (engagement, recognition, growth, manager, workload, autonomy, belonging, purpose, communication, wellbeing, fairness).
Pattern
^[a-z_]{2,30}$.
randomize_questionsbooleanjumpsobject[]Up to 20 items.
2 fields
whenobjectrequired2 fields
match"all" | "any"requiredrulesobject[]requiredUp to 20 items.
tostring | "end"required
variablesobject[]requiredUp to 20 items.
3 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.namestringrequiredUp to 80 characters.
initialnumber
outcomesobject[]requiredUp to 20 items.
4 fields
idstringrequiredPattern
^[A-Za-z0-9_-]{1,40}$.titlestringrequiredUp to 300 characters.
bodystring | nullUp to 5000 characters.
whenobjectrequired2 fields
match"all" | "any"requiredrulesobject[]requiredUp to 20 items.
5 fields
qstringPattern
^[A-Za-z0-9_-]{1,40}$.vstringPattern
^[A-Za-z0-9_-]{1,40}$.f"team" | "location" | "entity" | "language"opstring (enum)requiredOne of:
eq,neq,gt,gte,lt,lte,includes,excludes,answered,not_answered.valuestring | number | boolean | "null"
languagestringrequiredseedstringrequiredKeeps random orders the same for me.
personobjectrequired6 fields
first_namestring | nullrequiredteamstring | nullrequiredteam_idstring | nullrequiredlocationstring | nullrequiredlocation_idstring | nullrequiredentity_idstring | nullrequired
responseobject | nullrequired7 fields
status"partial" | "submitted"requiredlanguagestringrequiredanswersobjectrequiredothersobjectrequiredupdated_atstringrequiredsubmitted_atstring | nullrequiredoutcome_idstring | nullrequired
fullstring[]requiredChoices whose limit is reached ("<question id>:<choice id>").
locationsobject[]required2 fields
idstringrequiredlabelstringrequired
peopleobject[]requiredNamed surveys with a people question only.
2 fields
idstringrequiredlabelstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"survey_id":"s1"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"survey_id": "s1"
}),
});
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/surveys/me.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"survey_id": "s1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"token_issued": false,
"id": "s1",
"title": "Team pulse",
"mode": "confidential",
"status": "open",
"close_at": "2026-11-27T18:00:00.000Z",
"definition": {
"language": "en",
"languages": [
"pt-PT"
],
"translations": {
"pt-PT": {
"q:q1:title": "Recomendaria a empresa?"
}
},
"cover": {
"show": true,
"title": "Team pulse",
"body": "Five questions, two minutes."
},
"thanks": {
"title": "Thank you!",
"body": null,
"link_url": null,
"link_label": null,
"redirect_url": null
},
"layout": "one",
"progress": true,
"logo": true,
"pages": [
{
"id": "p1",
"title": null,
"description": null,
"questions": [
{
"id": "q1",
"type": "nps",
"title": "How likely are you to recommend us as a place to work?",
"required": true,
"low_label": "Not at all",
"high_label": "Very likely"
},
{
"id": "q2",
"type": "single",
"title": "Lunch, {{person:first_name}}?",
"choices": [
{
"id": "c1",
"label": "Fish",
"quota": 20
},
{
"id": "c2",
"label": "Veg"
}
],
"other": true
},
{
"id": "q3",
"type": "long_text",
"title": "What would you change?",
"show_if": {
"match": "all",
"rules": [
{
"q": "q1",
"op": "lte",
"value": 6
}
]
}
}
],
"jumps": []
}
],
"variables": [],
"outcomes": []
},
"language": "en",
"seed": "s1:p2",
"person": {
"first_name": "Bea",
"team": "Ops",
"team_id": "u1",
"location": "Lisbon",
"location_id": "l1",
"entity_id": "e1"
},
"response": {
"status": "partial",
"language": "en",
"answers": {
"q1": 8
},
"others": {},
"updated_at": "2026-11-13T10:00:00.000Z",
"submitted_at": null,
"outcome_id": null
},
"full": [],
"locations": [],
"people": []
}
}Save my survey answers for later#
POST/v1/surveys/me.saveWrite
Saves my answers so far, to come back to them (kept 30 days after the last save, never in results). Only while the survey is open and I haven't sent my answers. For anyone in the company, about themselves, in the app.
- Web app only
- Refused for API keys and connected apps. A person answers in the app.
- MCP tool
surveys_me_saveon 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
survey_idstringrequired1–64 characters.
answersobjectDefault
{}.othersobject"Other" texts by question id.
Default
{}.languagestringPattern
^[a-z]{2}(-[A-Z]{2})?$. Default"en".tokenstringAnonymous surveys: the one-time token from surveys_me_token, kept by the device.
20–100 characters.
Returns
saved_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.save \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"survey_id":"s1","answers":{"q1":8},"language":"en"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.save', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"survey_id": "s1",
"answers": {
"q1": 8
},
"language": "en"
}),
});
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/surveys/me.save",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"survey_id": "s1",
"answers": {
"q1": 8,
},
"language": "en",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"saved_at": "2026-11-13T10:00:00.000Z"
}
}Send my survey answers#
POST/v1/surveys/me.submitWrite
Sends my answers (once; they can't be changed after). Checked against the survey: required questions on my way through it, each type's rules, choices whose limit is reached (full). validation_failed lists the problems by question in details.errors. Returns the outcome screen when the survey has one. For anyone in the company, about themselves, in the app.
- Web app only
- Refused for API keys and connected apps. A person answers in the app.
- MCP tool
surveys_me_submiton 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
survey_idstringrequired1–64 characters.
answersobjectDefault
{}.othersobject"Other" texts by question id.
Default
{}.languagestringPattern
^[a-z]{2}(-[A-Z]{2})?$. Default"en".tokenstringAnonymous surveys: the one-time token from surveys_me_token, kept by the device.
20–100 characters.
Returns
submitted_atstringrequiredoutcomeobject | nullrequired3 fields
idstringrequiredtitlestringrequiredbodystring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.submit \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"survey_id": "s1",
"answers": {
"q1": 9
},
"language": "en",
"token": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT"
}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.submit', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"survey_id": "s1",
"answers": {
"q1": 9
},
"language": "en",
"token": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT"
}),
});
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/surveys/me.submit",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"survey_id": "s1",
"answers": {
"q1": 9,
},
"language": "en",
"token": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"submitted_at": "2026-11-13T10:05:00.000Z",
"outcome": null
}
}Get my one-time answer code for an anonymous survey#
POST/v1/surveys/me.tokenWrite
Anonymous surveys: gives me the one-time token my device answers with (once per person and survey). Bizisy keeps only its hash, the survey and the coarse bands the survey keeps (team, location or tenure band, as chosen), never who I am: my answers can't be tied to me, not even by Bizisy, and so they can't be moved to another device. conflict when a token was already given out for me. For anyone in the company, in the app.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_tokenon 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
survey_idstringrequired1–64 characters.
Returns
tokenstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.token \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"survey_id":"s1"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.token', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"survey_id": "s1"
}),
});
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/surveys/me.token",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"survey_id": "s1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"token": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT"
}
}Surveys of my team#
POST/v1/surveys/me.team_listRead
For a manager: the surveys with a manager view that went to people in their line (everyone who reports to them, directly or not), with whether their line has enough answers to show. For anyone in the company, about the people they manage.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_team_liston My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
itemsobject[]required5 fields
idstringrequiredtitlestringrequiredstatusstringrequiredmode"named" | "confidential" | "anonymous"requiredopened_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.team_list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.team_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/surveys/me.team_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": {
"items": [
{
"id": "s1",
"title": "Team pulse",
"status": "open",
"mode": "confidential",
"opened_at": "2026-11-13T09:00:00.000Z"
}
]
}
}My team's survey results#
POST/v1/surveys/me.team_resultsRead
For a manager, a survey's results for their own line only (everyone with them in their manager chain when it was sent), when the survey has the manager view: confidential surveys only above the threshold and never when the line minus a sub-line shown elsewhere could reveal a smaller group (leader triangulation guard). No breakdowns inside the line. not_found for a survey without a manager view or not sent to their line.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_team_resultson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
survey_idstringrequired1–64 characters.
langstringPattern
^[a-z]{2}(-[A-Z]{2})?$.
Returns
14 fields
survey_idstringrequiredtitlestringrequiredmode"named" | "confidential" | "anonymous"requiredstatusstringrequiredthresholdintegerrequiredcomment_thresholdintegerrequiredsegmentobject | nullrequired3 fields
kindstring (enum)requiredOne of:
team,manager,location,entity,tenure,field,source.idstringrequired1–160 characters.
namestringrequired
respondentsinteger | nullrequiredSubmitted answers in this view (null when hidden).
hiddenbooleanrequiredtrue: the numbers are withheld (fewer people than the threshold, or the next-smallest rule).
underinteger | nullrequiredHidden because fewer than N answered: N. Hidden with under null: shown, it would let someone work out a smaller hidden group by subtraction.
includedinteger | nullrequiredHow many of those answers the results include. Confidential surveys publish in steps of the threshold (never moved by one answer); null when hidden.
rateobjectrequired6 fields
invitedintegerrequiredansweredinteger | nullrequiredratenumber | nullrequired0–1; null when hidden or nobody invited.
hiddenbooleanrequiredtrue: the numbers are withheld (fewer people than the threshold, or the next-smallest rule).
underinteger | nullrequiredHidden because fewer than N answered: N. Hidden with under null: shown, it would let someone work out a smaller hidden group by subtraction.
byobject[]required8 fields
invitedintegerrequiredansweredinteger | nullrequiredratenumber | nullrequired0–1; null when hidden or nobody invited.
hiddenbooleanrequiredtrue: the numbers are withheld (fewer people than the threshold, or the next-smallest rule).
underinteger | nullrequiredHidden because fewer than N answered: N. Hidden with under null: shown, it would let someone work out a smaller hidden group by subtraction.
kindstring (enum)requiredOne of:
team,manager,location,entity,tenure,field,source.idstringrequirednamestringrequired
questionsobject[]required18 fields
idstringrequiredtypestringrequiredtitlestringrequiredpageintegerrequiredninteger | nullrequiredHow many answered it (null when hidden).
hiddenbooleanrequiredtrue: the numbers are withheld (fewer people than the threshold, or the next-smallest rule).
underinteger | nullrequiredHidden because fewer than N answered: N. Hidden with under null: shown, it would let someone work out a smaller hidden group by subtraction.
optionsobject[] | nullrequiredChoices, scale points, yes/no, locations: count and share.
4 fields
idstringrequiredlabelstringrequiredcountintegerrequiredsharenumberrequired0–1 of those who answered the question.
rowsobject[] | nullrequiredMatrix: per row.
3 fields
idstringrequiredlabelstringrequiredoptionsobject[]required4 fields
idstringrequiredlabelstringrequiredcountintegerrequiredsharenumberrequired0–1 of those who answered the question.
rankingobject[] | nullrequired3 fields
idstringrequiredlabelstringrequiredaverage_ranknumberrequired
meannumber | nullrequiredminnumber | nullrequiredmaxnumber | nullrequiredenpsobject | nullrequired0–10 questions: eNPS = % promoters (9–10) − % detractors (0–6).
5 fields
scoreintegerrequiredpromotersintegerrequiredpassivesintegerrequireddetractorsintegerrequirednintegerrequired
commentsstring[] | nullrequiredFree-text answers (confidential: masked, in alphabetical order, only from the comment threshold up; null when hidden).
comments_hiddenbooleanrequiredcomments_underinteger | nullrequiredcomment_idsstring | null[] | nullEach comment's opaque id, in the same order (reply with surveys_comments_reply); null for comments sent before replies existed.
publicobject | nullIts public link: answers through it (filter them with the segment source:public; source:people for the company's own). Absent: no link.
1 field
answeredintegerrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.team_results \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"survey_id":"s1"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.team_results', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"survey_id": "s1"
}),
});
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/surveys/me.team_results",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"survey_id": "s1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"survey_id": "s1",
"title": "Team pulse",
"mode": "confidential",
"status": "open",
"threshold": 5,
"comment_threshold": 10,
"segment": null,
"respondents": 12,
"included": 10,
"hidden": false,
"under": null,
"rate": {
"invited": 24,
"answered": 12,
"rate": 0.5,
"hidden": false,
"under": null,
"by": []
},
"questions": [
{
"id": "q1",
"type": "nps",
"title": "How likely are you to recommend us as a place to work?",
"page": 1,
"n": 12,
"hidden": false,
"under": null,
"options": [
{
"id": "0",
"label": "0",
"count": 0,
"share": 0
},
{
"id": "1",
"label": "1",
"count": 0,
"share": 0
},
{
"id": "2",
"label": "2",
"count": 0,
"share": 0
},
{
"id": "3",
"label": "3",
"count": 2,
"share": 0.1667
},
{
"id": "4",
"label": "4",
"count": 0,
"share": 0
},
{
"id": "5",
"label": "5",
"count": 0,
"share": 0
},
{
"id": "6",
"label": "6",
"count": 0,
"share": 0
},
{
"id": "7",
"label": "7",
"count": 4,
"share": 0.3333
},
{
"id": "8",
"label": "8",
"count": 0,
"share": 0
},
{
"id": "9",
"label": "9",
"count": 3,
"share": 0.25
},
{
"id": "10",
"label": "10",
"count": 3,
"share": 0.25
}
],
"rows": null,
"ranking": null,
"mean": 7.17,
"min": 3,
"max": 10,
"enps": {
"score": 33,
"promoters": 6,
"passives": 4,
"detractors": 2,
"n": 12
},
"comments": null,
"comments_hidden": false,
"comments_under": null
}
]
}
}Reply to a comment in my team's results#
POST/v1/surveys/me.team_replyWrite
For a manager, a reply to a comment their team's results show (manager view), on the same terms as HR's replies: the author stays unidentified. In the app.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_team_replyon 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
survey_idstringrequired1–64 characters.
comment_idstringrequired8–40 characters.
textstringrequired1–2000 characters.
Returns
8 fields
idstringrequiredsurvey_idstringrequiredquestion_idstringrequiredcomment_idstringrequiredquotestringrequiredmessagesobject[]required3 fields
from"hr" | "manager" | "person"requiredtextstringrequiredatstringrequired
unreadbooleanrequiredThe other side wrote last and it has not been read here.
updated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.team_reply \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"survey_id": "s1",
"comment_id": "c8x2k4m9q1zt",
"text": "Thanks, let us talk in our next 1:1 if you like."
}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.team_reply', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"survey_id": "s1",
"comment_id": "c8x2k4m9q1zt",
"text": "Thanks, let us talk in our next 1:1 if you like."
}),
});
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/surveys/me.team_reply",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"survey_id": "s1",
"comment_id": "c8x2k4m9q1zt",
"text": "Thanks, let us talk in our next 1:1 if you like.",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "t1",
"survey_id": "s1",
"question_id": "why",
"comment_id": "c8x2k4m9q1zt",
"quote": "More focus time, please.",
"messages": [
{
"from": "manager",
"text": "Thanks, let us talk.",
"at": "2026-11-14T10:00:00.000Z"
}
],
"unread": false,
"updated_at": "2026-11-14T10:00:00.000Z"
}
}My conversations on my team's survey comments#
POST/v1/surveys/me.team_threadsRead
For a manager (manager view), the conversations they started on comments in their team's results, with the authors' answers (never who they are).
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_team_threadson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
survey_idstringrequired1–64 characters.
Returns
itemsobject[]required8 fields
idstringrequiredsurvey_idstringrequiredquestion_idstringrequiredcomment_idstringrequiredquotestringrequiredmessagesobject[]required3 fields
from"hr" | "manager" | "person"requiredtextstringrequiredatstringrequired
unreadbooleanrequiredThe other side wrote last and it has not been read here.
updated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.team_threads \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"survey_id":"s1"}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.team_threads', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"survey_id": "s1"
}),
});
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/surveys/me.team_threads",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"survey_id": "s1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "t1",
"survey_id": "s1",
"question_id": "why",
"comment_id": "c8x2k4m9q1zt",
"quote": "More focus time, please.",
"messages": [
{
"from": "hr",
"text": "Thank you, can you say more?",
"at": "2026-11-14T10:00:00.000Z"
}
],
"unread": false,
"updated_at": "2026-11-14T10:00:00.000Z"
}
]
}
}Replies to my survey comments#
POST/v1/surveys/me.threadsRead
Replies HR or a manager wrote to my survey comments, and my answers. Anonymous surveys: only those on this device (pass the one-time codes it keeps, by survey). For anyone in the company, about their own comments.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_threadson My Workplace- Method
POSTwith a JSON body only (an input field carries a secret)
Input
tokensobjectDefault
{}.
Returns
itemsobject[]required9 fields
idstringrequiredsurvey_idstringrequiredquestion_idstringrequiredcomment_idstringrequiredquotestringrequiredmessagesobject[]required3 fields
from"hr" | "manager" | "person"requiredtextstringrequiredatstringrequired
unreadbooleanrequiredThe other side wrote last and it has not been read here.
updated_atstringrequiredsurvey_titlestringrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.threads \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"tokens":{"s5":"TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT"}}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.threads', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"tokens": {
"s5": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT"
}
}),
});
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/surveys/me.threads",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"tokens": {
"s5": "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT",
},
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "t1",
"survey_id": "s1",
"question_id": "why",
"comment_id": "c8x2k4m9q1zt",
"quote": "More focus time, please.",
"messages": [
{
"from": "hr",
"text": "Thank you, can you say more?",
"at": "2026-11-14T10:00:00.000Z"
}
],
"unread": true,
"updated_at": "2026-11-14T10:00:00.000Z",
"survey_title": "Team pulse"
}
]
}
}Answer a reply to my survey comment#
POST/v1/surveys/me.thread_replyWrite
Answers HR's or a manager's reply to my comment (anonymous surveys: with the one-time code this device keeps). They read it without learning who I am. No Activity entry. At most 10 a day. In the app.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_thread_replyon 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
thread_idstringrequired1–64 characters.
textstringrequired1–2000 characters.
tokenstring20–100 characters.
read_onlybooleantrue: only mark it read.
Default
false.
Returns
8 fields
idstringrequiredsurvey_idstringrequiredquestion_idstringrequiredcomment_idstringrequiredquotestringrequiredmessagesobject[]required3 fields
from"hr" | "manager" | "person"requiredtextstringrequiredatstringrequired
unreadbooleanrequiredThe other side wrote last and it has not been read here.
updated_atstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.thread_reply \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"thread_id":"t1","text":"More remote days would help."}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.thread_reply', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"thread_id": "t1",
"text": "More remote days would help."
}),
});
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/surveys/me.thread_reply",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"thread_id": "t1",
"text": "More remote days would help.",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "t1",
"survey_id": "s1",
"question_id": "why",
"comment_id": "c8x2k4m9q1zt",
"quote": "More focus time, please.",
"messages": [
{
"from": "hr",
"text": "Thank you, can you say more?",
"at": "2026-11-14T10:00:00.000Z"
},
{
"from": "person",
"text": "More remote days would help.",
"at": "2026-11-14T00:00:00.000Z"
}
],
"unread": false,
"updated_at": "2026-11-14T10:00:00.000Z"
}
}My actions from survey results#
POST/v1/surveys/me.actionsRead
The actions from survey results I own (open first): what to do, by when, the group and the number it should move, and where that number went in the latest later round. For anyone in the company, about themselves.
- Who can call it
- Me key owner admin hr member
- MCP tool
surveys_me_actionson My Workplace- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
itemsobject[]required14 fields
idstringrequiredsurvey_idstringrequiredsurvey_titlestringrequiredround_nointegerrequiredsegmentobject | nullrequired3 fields
kindstringrequiredidstringrequirednamestringrequired
metricobjectrequired2 fields
keystringrequiredtitlestringrequired
baselinenumber | nullrequiredtitlestringrequiredownerobjectrequired2 fields
idstringrequirednamestringrequired
duestring | nullrequiredstatus"open" | "done"requiredcheckobject | nullrequiredThe latest later round with results: the same number for the same group (null value: hidden there).
3 fields
round_nointegerrequiredsurvey_idstringrequiredvaluenumber | nullrequired
created_atstringrequireddone_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found module_disabled rate_limited internal
curl https://api.bizisy.com/v1/surveys/me.actions \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/surveys/me.actions', {
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/surveys/me.actions",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"items": [
{
"id": "a1",
"survey_id": "s1",
"survey_title": "Team pulse",
"round_no": 3,
"segment": {
"kind": "team",
"id": "u1",
"name": "Engineering"
},
"metric": {
"key": "enps",
"title": "eNPS"
},
"baseline": 18,
"title": "Weekly focus time",
"owner": {
"id": "p2",
"name": "Bea Silva"
},
"due": "2026-12-31",
"status": "open",
"check": {
"round_no": 4,
"survey_id": "s9",
"value": 31
},
"created_at": "2026-11-13T10:00:00.000Z",
"done_at": null
}
]
}
}Something missing or wrong on this page? Write to hello@bizisy.com.