Skip to content
Developers

Authentication

What API keys and connected apps can see

On this page

Bizisy treats every API key and every connected AI app as a machine. A machine acts as its person, with their role, but it gets less than that person does in the web app: other people's private and pay data never leave Bizisy through a machine, and a few actions stay with a person signed in to Bizisy.

These rules are checked by the server on every call, the same way for REST and MCP and for keys and connected apps. They don't depend on the client.

Other people's private and pay data#

Each field of a person has a visibility tier: public, job, private or pay.

TierA person in the web appA machine
Public (name, work email, title, team, photo)Everyone in the companyThe same
Job (job details and history, contract terms)The person, their managers, owners, admins and HRThe same
Private (personal contact details, address, birthday, emergency contacts, payroll identifiers)The person, owners, admins and HROnly the person's own
PayThe person, owners, admins and HROnly the person's own

So an HR Manage key reading someone else gets their public and job tiers: private fields come back null and private custom fields are left out (visible_tiers says which tiers you got). The same key reading its own person gets everything. Webhook payloads follow the same rule.

Files follow it too: through a machine, other people's documents come as metadata only and never download, and someone else's file in a custom field shows its size and type, not its name.

Actions that stay in the web app#

Some actions are refused for every machine, whatever the role. They hand out secrets, move money or switch off a safeguard, so a person signed in to Bizisy does them:

ActionWhy
platform.roles.createRoles are created in the app only, so an assistant can never widen anyone's access.
platform.roles.updateRoles are changed in the app only.
platform.roles.deleteRoles are deleted in the app only.
platform.members.set_access_untilAn outsider's end date is changed in the app only.
platform.me.two_stepTwo-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
platform.me.two_step.changedTwo-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
platform.push.subscribePush notifications are turned on in a browser or the installed app.
platform.credits.checkoutCredit packs are bought on Stripe's page in the browser, by owners and admins signed in to Bizisy.
platform.storage.limit.setThe storage limit is raised or lowered in the app only (Settings → Plan & billing), by an owner or admin.
platform.features.updateModules and AI and API access are switched in the app only (Settings → Modules), by an owner or admin.
platform.promotions.redeemPromotion codes are redeemed in the app only, by an owner or admin.
platform.ai_addendum.requestAsking owners to accept the AI features addendum is done in the Bizisy app.
platform.dpa.acceptThe data processing agreement is accepted in the app only, by an owner.
platform.billing.checkoutPayment pages open in the browser, for owners and admins signed in to Bizisy.
platform.billing.portalPayment pages open in the browser, for owners and admins signed in to Bizisy.
platform.billing.invoices.pdfInvoices download in the browser, for owners and admins signed in to Bizisy.
platform.billing.payInvoices are paid on Stripe's page in the browser, by owners and admins signed in to Bizisy.
org.pay.addPay is recorded in the app only.
org.pay.removePay is changed in the app only.
org.pay.importPay history is imported in the app only.
org.health_checks.recordHealth-check dates are changed by owners, admins and HR signed in to Bizisy (or a role allowed sensitive details).
org.health_checks.set_dueHealth-check dates are changed by owners, admins and HR signed in to Bizisy (or a role allowed sensitive details).
org.one_on_ones.setup_teamA manager sets up their team's 1:1s in the Bizisy app.
org.one_on_ones.start_meetingThe two people hold the meeting in the Bizisy app.
org.one_on_ones.finishThe two people wrap up the meeting in the Bizisy app.
org.one_on_ones.healthHR reads 1:1 health in the Bizisy app.
org.one_on_ones.nudge_managersHR asks or reminds managers from the Bizisy app.
org.one_on_ones.exemption_requestExemptions carry a justification: asked for in the Bizisy app.
org.one_on_ones.exemption_decideExemptions are decided in the Bizisy app.
org.one_on_ones.exemption_closeWithdrawn or ended in the Bizisy app.
org.announcements.publishPublishing stays in the Bizisy app; machines may draft.
org.announcements.acknowledgeEach person confirms in the Bizisy app or at the time clock kiosk.
org.positions.approval_rule.updateWho approves new positions is set in the app only, so an assistant can never switch approval off.
org.positions.decideApproving a position needs a person signed in to Bizisy.
org.approvals.settings.updateWho approves changes is set in the app only, so an assistant can never switch approval off.
org.approvals.approveApproving needs a person signed in to Bizisy.
org.approvals.rejectRejecting needs a person signed in to Bizisy.
org.titles.settings.updateWho may add job titles is set in the app only, so an assistant can never widen it.
org.pay_bands.listPay bands are pay data: read in the app only.
org.pay_bands.setPay bands are set in the app only.
org.pay_bands.removePay bands are changed in the app only.
org.title_evaluations.approveApproving evaluations needs a person signed in to Bizisy.
org.pay_categories.setCategories of workers are set in the app only.
org.pay_categories.removeCategories of workers are changed in the app only.
org.pay_equity.settings.updatePay equity settings are changed in the app only.
org.pay_equity.overviewThe pay gap is pay data: read in the app only.
org.pay_reports.listPay gap reports are pay data: read in the app only.
org.pay_reports.getPay gap reports are pay data: read in the app only.
org.pay_reports.createPay gap reports are made in the app only.
org.pay_reports.upload_variableVariable pay is uploaded in the app only.
org.pay_reports.componentsHow pay items count in a report is chosen in the app only.
org.pay_reports.justifyPay gaps are justified in the app only.
org.pay_reports.finalisePay gap reports are finalised in the app only.
org.pay_reports.mark_submittedSubmissions are recorded in the app only.
org.pay_reports.removePay gap reports are deleted in the app only.
org.pay_reports.exportPay gap reports are exported in the app only.
org.pay_requests.listPeople's pay requests are pay data: read in the app only.
org.pay_requests.replyPay requests are answered in the app only.
org.pay_requests.recordRequests received on paper are recorded in the app only.
org.pay_equity.reminder_statusWho was reminded of the right to ask about pay is read in the app only.
org.access.preview_personPreviewing a role is for owners and admins signed in to Bizisy.
org.outsiders.inviteOutside access is given in the app only.
org.directory.connectAn owner or admin connects a directory in the app (Integrations → Google Workspace or Microsoft 365 → Directory sync).
org.directory.disconnectDisconnecting happens in the app.
org.directory.settings.updateDirectory sync settings change in the app only.
org.directory.importThe one-time import runs in the app.
org.directory.linkLinking a person to an account happens in the app.
org.directory.excludeExcluding someone from directory sync happens in the app.
org.directory.confirmA person confirms new and reactivated accounts in the app.
org.directory.retryRetrying a failed change happens in the app.
org.directory.reveal_passwordA first password is shown only in the app, once.
org.chat.connectAn owner or admin connects a chat tool in the app (Integrations, Chat: Slack, Microsoft Teams, Google Chat, Mattermost, Discord or Rocket.Chat).
org.chat.settings.updateThe channel and what is announced change in the app only.
org.chat.testTest messages are sent from the app.
org.chat.skipSkipping an announcement happens in the app.
org.chat.retryTrying a failed announcement again happens in the app.
org.chat.disconnectDisconnecting happens in the app.
org.spend.startAn owner or admin starts syncing a spend tool in the app, after reviewing the plan.
org.spend.confirmA person confirms invites and card blocks in the app.
org.spend.excludeExcluding someone from a spend tool sync happens in the app.
org.spend.retryRetrying a failed change happens in the app.
org.learning.chooseA person confirms or excludes people for a learning platform in the app (Integrations → the platform → People).
org.scim.tokens.createAn owner or admin creates SCIM tokens in the app (Integrations → SCIM): a token is never made with a key.
org.scim.tokens.revokeRevoking a SCIM token happens in the app.
org.okta.confirmA person confirms new, reactivated and held Okta account changes in the app.
org.okta.excludeKeeping someone out of Okta provisioning happens in the app.
org.okta.retryRetrying a failed Okta change happens in the app.
org.ats.hires.acceptHR adds a hire from a recruiting tool in the app.
org.ats.hires.linkLinking a hire to someone already in Bizisy happens in the app.
org.ats.hires.dismissDismissing a hire happens in the app.
org.bank.requestBank accounts change in the app only (Verified bank details).
org.bank.proof.startBank accounts change in the app only (Verified bank details).
org.bank.proof.finishBank accounts change in the app only (Verified bank details).
org.bank.decideBank accounts change in the app only (Verified bank details).
org.bank.cancelBank accounts change in the app only (Verified bank details).
org.bank.getBank accounts change in the app only (Verified bank details).
org.bank.changes.listBank accounts change in the app only (Verified bank details).
org.bank.proof_urlBank accounts change in the app only (Verified bank details).
org.bank.settings.getBank accounts change in the app only (Verified bank details).
org.bank.settings.updateBank accounts change in the app only (Verified bank details).
org.planning.itemsNames people with future last days: owners, admins and HR in the Bizisy app.
org.planning.scenarios.adoptAdopting a scenario changes the budget: in the Bizisy app.
data.feed.token_createAn owner or admin creates the BI token in the app (Integrations → Power BI and Excel → Access): it is shown once there.
data.feed.token_revokeRevoking the BI token happens in the app.
data.pay.setSharing pay with data tools is a person's choice in the app (Integrations → Power BI and Excel → Access), recorded in Activity.
documents.signatures.upload_signed.startSigned copies are uploaded by HR in the app.
documents.signatures.upload_signed.finishSigned copies are uploaded by HR in the app.
documents.me.signatures.upload_signed.startPeople upload what they signed in the app.
documents.me.signatures.upload_signed.finishPeople upload what they signed in the app.
documents.templates.settings.updateWho approves templates is set by owners and admins in the app.
documents.templates.decideA person approves template versions in the app (Approvals).
documents.me.acceptAccepting a document is done by the person in the app.
documents.consent.setConsent to electronic documents is recorded by HR or the person in the app.
documents.me.consent.setThe person agrees in the app, signed in themselves.
documents.prepared.getOpening a prepared document (its preview holds pay and private details) is done in the app.
documents.me.statement.requestThe person asks in the app, signed in themselves.
documents.me.policies.acknowledgeThe person acknowledges a policy in the app, signed in themselves.
documents.me.declarations.requestThe person asks in the app, signed in themselves.
payroll.schedules.setPay schedules and the bank account are set in the app only.
payroll.sepa.createThe SEPA salary file is made in the app only.
payroll.consents.grantOnly a person signed in to Bizisy lets a machine receive pay data.
payroll.consents.revokeConsents are revoked in the app only.
payroll.payslips.downloadUnmatched payslips are opened in the app only.
payroll.push.sendSending a pay period to a payroll tool happens in the app only.
timeoff.requests.decideApproving or declining time off needs a person signed in to Bizisy.
timeoff.feeds.createCalendar feeds are created in the app only (the result is a private link).
timeclock.corrections.decideDeciding or confirming a time correction needs a person signed in to Bizisy.
timeclock.corrections.apply_anywayApplying a disputed correction needs HR signed in to Bizisy.
timeclock.months.reopenReopening a closed month needs HR signed in to Bizisy.
timeclock.months.acknowledgePeople acknowledge their month in the app only.
timeclock.pin.setA kiosk PIN is set by the person in the app only.
timeclock.kiosks.createKiosks are set up in the app only (the result is a one-time device link).
timeclock.overtime.decideApproving or declining overtime needs a person signed in to Bizisy.
timeclock.overtime.settleApproving overtime already worked (or marking it not overtime) needs a person signed in to Bizisy.
timeclock.terminals.createTerminals are added in the app only (the result holds the terminal's one-time server address).
timeclock.terminals.rotateA new terminal address is made in the app only (it is shown once).
shifts.week.publishA person publishes a rota in the app: it tells people and has legal effect. A dry run is not offered either.
shifts.requests.approveAn editor approves shift requests in the app.
shifts.requests.declineAn editor declines shift requests in the app.
shifts.feeds.createCalendar feed links are created in the app (the link is a secret).
hiring.settings.updateHiring settings change in the app only (Settings → Hiring): they include the referral bonus.
hiring.jobs.preview_pageLive previews of a job's page show in the app only (Hiring → the job → Job post); machines read the job with hiring.jobs.get.
hiring.settings.preview_pageLive previews of the careers page show in the app only (Settings → Hiring).
hiring.settings.preview_emailPreviews of the emails to candidates show in the app only (Settings → Hiring → Candidates).
hiring.applications.moveMoving candidates happens in the app: a person decides.
hiring.applications.reject"Not this time" is decided in the app: a person decides, never an AI.
hiring.applications.cancel_rejectTaking back a "not this time" happens in the app.
hiring.applications.messageWriting to candidates happens in the app; machines may draft the text.
hiring.applications.addAdding a candidate (it emails them) happens in the app.
hiring.referrals.createReferring someone (it emails them) happens in the app.
hiring.referrals.mark_paidReferral bonuses are marked paid in the app only.
hiring.candidates.eraseErasing a candidate happens in the app only.
hiring.candidates.exportA candidate's data export happens in the app only.
hiring.interviews.bookBooking an interview (it emails the candidate and the interviewers) happens in the app.
hiring.interviews.offerOffering interview times (it emails the candidate) happens in the app.
hiring.interviews.rescheduleMoving an interview (it emails everyone) happens in the app.
hiring.interviews.cancelCancelling an interview (it emails everyone) happens in the app.
hiring.interviews.no_showA no-show is recorded in the app.
hiring.feedback.saveFeedback is written by the interviewer in the app.
hiring.feedback.submitFeedback is sent by the interviewer in the app.
hiring.feedback.add_noteCorrections to feedback are added by its author in the app.
hiring.me.interviewsAn interviewer's own interviews are read in the app (My workspace → Interviewing).
hiring.me.interviewInterview kits (the candidate's CV and answers) are for the interviewer in the app.
hiring.contribution.thankSaying thanks (it emails people) happens in the app.
hiring.offers.draftOffers are made in the app; machines may suggest the terms.
hiring.offers.updateOffers are changed in the app.
hiring.offers.submitOffers are checked and sent for approval in the app.
hiring.offers.decideOffers are approved in the app: a person decides.
hiring.offers.sendSending an offer (it emails the candidate) happens in the app.
hiring.offers.withdrawWithdrawing an offer (it emails the candidate) happens in the app.
hiring.offers.reviseRevising an offer (it emails the candidate) happens in the app.
hiring.letters.updateOffer letters change in the app only (Settings → Hiring → Offer letters); machines may draft the text.
hiring.letters.resetOffer letters change in the app only.
hiring.handoff.applyThe handoff after a hire (a buddy, the first 1:1, closing the job with replies) is finished in the app.
hiring.internal.applyPeople apply for jobs inside the company themselves, in My workspace; an AI never applies for them.
hiring.internal.withdrawThe person withdraws in My workspace.
hiring.internal.cv_upload_urlThe person uploads their CV in My workspace when they apply.
hiring.offers.accept_internalThe person accepts their offer in My workspace.
hiring.offers.decline_internalThe person declines their offer in My workspace.
hiring.offers.finish_transferHR finishes an internal move in the Bizisy app.
training.me.reportThe person reports their own training in the app.
training.certificates.uploadCertificates are uploaded in the app.
training.certificates.downloadCertificates are private: they are downloaded in the app.
surveys.me.saveA person answers in the app.
surveys.me.submitA person answers in the app.
surveys.council.requestHR asks the works council in the app.
surveys.council.decideThe works council decides in the app.
surveys.public.setA public link is switched on in the app, where its rules are shown.
talent.cycles.preview_emailPreviews of the review cycle emails show in the app only (Talent → Performance → Preview emails).
talent.reviews.getReviews (answers, ratings, feedback) are read in the app only.
talent.reviews.answerReviews are written in the app only.
talent.reviews.submitReviews are submitted in the app only.
talent.reviews.signoffSign-off happens in the app only.
talent.reviews.send_backSending back happens in the app only.
talent.feedback.nominationsWho gives feedback is shown in the app only.
talent.feedback.nominatePeople choose their peers in the app only.
talent.feedback.decideManagers approve peers in the app only.
talent.feedback.mineFeedback requests are answered in the app only.
talent.feedback.answerFeedback is given in the app only.
talent.feedback.declineDeclining happens in the app only.
talent.goals.suggest_statusWhether goal suggestions can be asked for is read in the app only.
talent.goals.suggest_measuresAI suggestions of measures for a goal are asked for in the app only (an AI calling an AI would spend credits).
talent.cycles.sex_checkRatings by sex are checked in the app only.
comp.cycles.getA cycle's setup, budgets and progress hold pay: read in the app only.
comp.cycles.createSalary reviews are set up in the app only.
comp.cycles.updateSalary reviews are set up in the app only.
comp.cycles.publish_criteriaCriteria are published to staff in the app only.
comp.cycles.launchA salary review is launched in the app only.
comp.cycles.stepLarge launches and releases continue in the app (or by the sweep).
comp.cycles.cancelA salary review is cancelled in the app only.
comp.cycles.release_nowA salary review is released in the app only: it writes pay and sends letters.
comp.cycles.exportThe payroll file holds pay: exported in the app only.
comp.worksheet.getA manager's worksheet is read in the app only.
comp.worksheet.saveProposals are made in the app only.
comp.worksheet.submitWorksheets are submitted in the app only.
comp.worksheet.amountsPay on a worksheet shows in the app only.
comp.upper.getTeam worksheets are checked in the app only.
comp.upper.saveTeam worksheets are checked in the app only.
comp.upper.submitTeam worksheets are checked in the app only.
comp.upper.returnTeam worksheets are checked in the app only.
comp.signoff.getThe final sign-off holds pay totals: in the app only.
comp.cycles.sign_offSalary reviews are signed off in the app only.
comp.cycles.send_backSalary reviews are sent back in the app only.
comp.review.getHR reviews proposals in the app only.
comp.review.decideProposals are approved in the app only.
comp.review.editHR changes proposals in the app only.
comp.review.returnWorksheets are sent back in the app only.
comp.review.refreshRows are refreshed in the app only.
comp.review.skipRows are skipped in the app only.
comp.review.equityThe equity check is read in the app only.
comp.review.mark_paidLump sums are marked paid in the app only.
comp.review.rating_checkRatings and raises by sex are checked in the app only.
comp.letters.mineLetters hold pay: read in the app only.
comp.letters.getLetters hold pay: read in the app only.
comp.bonus.plans.getA plan's formula, totals and payouts hold pay: read in the app only.
comp.bonus.plans.createBonus plans are set up in the app only.
comp.bonus.plans.updateBonus plans are set up in the app only.
comp.bonus.plans.publish_formulaThe formula is published to staff in the app only.
comp.bonus.plans.launchA bonus plan is launched in the app only.
comp.bonus.plans.stepLarge launches and releases continue in the app (or by the sweep).
comp.bonus.plans.cancelA bonus plan is cancelled in the app only.
comp.bonus.plans.release_nowA bonus plan is released in the app only: it pays and sends letters.
comp.bonus.awards.listAwards hold pay: read in the app only.
comp.bonus.awards.adjustAwards are adjusted in the app only.
comp.bonus.awards.decideAwards are approved in the app only.
comp.bonus.equityThe equal-pay check is read in the app only.
comp.bonus.awards.mark_paidAwards are marked paid in the app only.
insights.settings.updateTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.notice.sendTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.problems.reportTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.people.listTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.people.getTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.reviews.recordTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.recomputeTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.exclusions.listTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.exclusions.setTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.explanations.listTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.explanations.replyTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.me.objectAn objection is the person's own click in My workspace.
insights.me.explanation.askAsking for an explanation is the person's own click in My workspace.
insights.audit.listTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.audit.exportTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.checks.bias.runTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.checks.listTalent insights is used in the Bizisy app, by a person (EU AI Act human oversight).
insights.checks.backtest.runThe back-test runs in the Bizisy app, by a person (EU AI Act human oversight).
insights.checks.backtest.acknowledgeAn owner or admin acknowledges the back-test in the app only.
insights.checks.backtest.getBack-test results are read in the app only.
migration.resumeA move in the background is resumed by a person signed in to Bizisy.
migration.undoUndoing a move needs a person signed in to Bizisy.
migration.exports.previewMoving to another tool happens in the Bizisy web app.
migration.exports.startMoving to another tool happens in the Bizisy web app.
migration.exports.getMoving to another tool happens in the Bizisy web app.
migration.exports.listMoving to another tool happens in the Bizisy web app.
migration.exports.downloadMoving to another tool happens in the Bizisy web app.
migration.exports.removeMoving to another tool happens in the Bizisy web app.
webhooks.endpoints.createEndpoints are added in the app only (the result is a secret, and data starts flowing to a new place).
webhooks.endpoints.deleteEndpoints are deleted in the app only.
webhooks.endpoints.roll_secretSecrets are rolled in the app only (the result is a secret).
accounting.journals.listHeadcount-cost journals carry pay totals: they are read in the app only.
accounting.journals.getHeadcount-cost journals carry pay totals: they are read in the app only.
accounting.journals.prepareHR prepares a journal from pay in the app only (pay consent, P11).
accounting.journals.approveApproving a journal needs a person signed in to Bizisy.
accounting.journals.discardDiscarding a journal happens in the app.
integrations.connections.connectAn owner or admin connects a tool in the app (Integrations): credentials and access grants never pass through a key.
integrations.connections.updateA connection's settings and its events secret change in the app only.
integrations.connections.disconnectDisconnecting happens in the app.
country.notices.prepareA notice's data (NISS, date of birth, pay) is private: it is prepared in the app.
country.notices.submitHR reviews and sends a notice to Segurança Social in the app.
country.credentials.setSegurança Social access is entered by an owner or admin in the app.
country.credentials.clearSegurança Social access is removed in the app.
country.relatorio_unico.generateThe Relatório Único files hold private and pay data: they are made in the app.
country.relatorio_unico.annual.setThe yearly forms name health and safety staff: they are saved in the app.
country.relatorio_unico.providers.saveService providers hold private identifiers: they are entered in the app.
country.relatorio_unico.providers.removeThe service providers list is changed in the app.
country.relatorio_unico.providers.importService providers hold private identifiers: they are imported in the app.

The API reference marks them Web app only.

Actions with limits for machines#

These work for machines, with a limit:

ActionFor keys and apps
platform.me.companiesOnly the company the key or app belongs to.
platform.connections.revokeOnly your own connections (owners and admins disconnect others in the app).
platform.members.set_roleBuilt-in roles only: a custom role is given in the app.
platform.activity.changesOther people's pay and private values come back hidden (hidden: true, no values).
platform.activity.about_personPay and private values come back hidden (hidden: true, no values).
org.units.listPrivate team custom fields are never returned.
org.units.createPrivate team custom fields are refused.
org.units.updatePrivate team custom fields are refused and never returned.
org.people.listThe HR filters legal_entity_id, joined_between and left_between are refused.
org.people.getPrivate fields only for yourself.
org.people.hirePayroll details (tax_id, social_security_number, iban) and sex are refused.
org.people.update_profilePayroll details (tax_id, social_security_number, iban) and sex are refused.
org.me.updatePayroll details (tax_id, social_security_number, iban) are refused.
org.setup.applyPayroll details, sex and private custom fields (of people and teams) are refused.
org.people.import_csvPayroll details, sex and private custom fields are refused.
org.invites.createurl is null: the sign-in link is only emailed to the person.
org.invites.create_manyThe sign-in links are only emailed to the people, never returned.
org.people.inviteEach invite.url is null: the sign-in links are only emailed to the people.
org.fields.updateconfirm_expose_existing (widening a tier while people have values) is refused.
org.pay.listOnly your own pay.
org.people.export_csvinclude_private is refused.
org.people.export_dataOnly for yourself (or use org.me.export_data).
org.health_checks.listLists nobody unless the company allowed sensitive details for this key or app.
org.check_ins.getOnly your own quarterly check-in.
org.check_ins.answerOnly your own answers.
org.check_ins.prepareOnly your own 1:1 and check-in.
org.one_on_ones.getOnly your own 1:1 with your manager; a manager's side stays in Bizisy.
org.one_on_ones.noteOnly your own private note in your own 1:1.
org.announcements.updateDrafts and scheduled ones only; a published announcement changes in the app.
org.positions.listpay_range (the budget) is never returned (pay_range_hidden is true).
org.positions.createpay_range and private custom fields are refused.
org.positions.updatepay_range and private custom fields are refused.
org.cases.listJoiners missing payroll details (missing_details) are left out.
org.changes.applyPay changes are refused: save the set with org.changes.draft and a person applies it in the app.
org.changes.draftPay amounts are never returned.
org.changes.listPay amounts are never returned.
org.changes.getPay amounts are never returned.
org.titles.createRefused when the company lets only HR add job titles (org.titles.settings.update).
org.pay_bands.positionOnly your own band, and only when the company shows bands to people.
org.title_evaluations.setDrafts only (source "ai") for HR to approve; an approved evaluation is refused.
org.drafts.savePrivate details and pay are refused (the person adds them in the app).
org.drafts.getPrivate details and pay are left out.
org.imports.startCSV text of at most 250 people; files are imported in the app.
org.imports.checkPayroll details, sex and private custom fields are refused; only runs the key or app started.
org.imports.getPayroll, sex and private cells of the sample rows are hidden.
org.imports.rowsPayroll, sex and private cells are hidden.
org.imports.applyOnly runs the key or app started.
org.imports.fix_rowsOnly runs the key or app started; payroll, sex and private cells are kept as they were.
org.reports.overviewPay and the gender split are null (pay_hidden, gender_hidden: apps): they are shown only in Bizisy.
org.analytics.tableNo gender, age band or custom-field dimensions; absence and regretted attrition only with rows "all" and no filter (hidden: apps); regretted cells never carry numerators.
org.analytics.exportAs the table: diversity tables, and absence or regretted by group, download in the Bizisy app only.
org.groups.listGroups with a private field are left out, and private fields never count for members.
org.groups.updateA group a custom role uses decides whom the role covers: changing it needs an owner or admin signed in to Bizisy.
org.ats.hires.listKeys and connected apps see the hires without the candidate's personal email.
org.planning.forecastHeadcount and FTE only: cost is left out (cost_hidden apps); the people behind a number are in the app.
org.planning.scenarios.listOn-cost and cost per head are left out.
org.planning.scenarios.getOn-cost and cost per head are left out.
org.planning.scenarios.createDrafts without on-cost or cost per head (refused if sent).
org.planning.scenarios.updateOn-cost and cost per head are refused if sent; what HR entered is kept.
org.planning.scenarios.archiveOn-cost and cost per head are left out of the result.
org.planning.scenarios.restoreOn-cost and cost per head are left out of the result.
org.planning.scenarios.compareHeadcount and FTE only: cost is left out.
org.planning.settings.getThe on-cost is left out.
org.planning.settings.updateThe on-cost is refused if sent.
org.planning.exportHeadcount and FTE columns only: no cost.
documents.listOther people's documents come as metadata only.
documents.downloadOther people's documents never download.
documents.field_file.startOther people's files are never returned.
documents.signatures.listOther people's signature requests come as ids and statuses, without signers' names.
documents.templates.getTemplates with pay details come without their text.
documents.templates.createNo templates with pay details.
documents.templates.updateNo templates with pay details.
documents.templates.previewNot for templates with pay details; private details only for the sample person.
documents.templates.import_docxNo pay fields in the draft it makes.
documents.generateOnly templates without private or pay details.
documents.generated.listOther people's documents come as metadata only.
documents.exportNever other people's documents; no templates with pay details.
documents.prepared.decideMachines may discard; sending and editing are done in the app.
documents.prepared.createThrough machines, the amendment never reads pay changes.
payroll.periods.getPay and private values only with a consent (Payroll → Settings → Machine access); otherwise null and listed in withheld.
payroll.items.importNames people by person id or employee number only, unless a consent covers private data.
payroll.exports.createNeeds a consent for pay and private data (Payroll → Settings → Machine access).
payroll.exports.downloadNeeds a consent for pay and private data.
payroll.net_pay.importNeeds a consent for pay data; names people by person id or employee number only, unless the consent covers private data.
payroll.workspaceOnly the company the key or app belongs to.
payroll.payslips.startNeeds a consent for pay data.
payroll.payslips.finishNeeds a consent for pay data.
payroll.attachments.downloadNeeds a consent for pay and private data.
payroll.push.previewPay values only with a consent (Payroll → Settings → Machine access); otherwise null.
timeoff.bookOnly for the key's or app's own person; booking for someone else needs a person signed in.
timeoff.away.listOther people's days come as "Away" only (dates and half days; never the type, note or status).
timeclock.punchOnly for the key's or app's own person, at the current time (no offline clockings).
timeclock.records.listOther people's records only with the company's machine consent for private data; never locations.
timeclock.corrections.requestOnly for the key's or app's own person; correcting someone else needs a person signed in.
timeclock.settings.updateLocation, corrections, overtime approval and retention settings are changed in the app only.
timeclock.overtime.requestOnly for the key's or app's own person, when the company lets people ask for their own overtime.
timeclock.overtime.listOther people's overtime only with the company's machine consent for private data.
timeclock.overtime.unapprovedOther people's days only with the company's machine consent for private data.
timeclock.punches.ingestOnly owners', admins' and HR's API keys (a terminal's software), never connected AI apps or MCP; punches sent over 15 minutes late wait for the person's confirmation.
shifts.week.historyNever the note of an "other" reason.
shifts.requests.listNever the private messages.
shifts.my.availability.listNever the private notes.
shifts.my.availability.setNotes are neither read nor written; existing notes are kept.
shifts.settings.updateRest rules as blocks and auto-approved claims are changed in the app.
hiring.jobs.listThe pay range of a job never opened is hidden (salary_hidden).
hiring.jobs.getThe pay range of a job never opened is hidden (salary_hidden).
hiring.jobs.createThe pay range is copied from the position, and hidden in the result until the job is opened.
hiring.jobs.updatePay ranges (salary) and referral bonuses are set in the app only.
hiring.jobs.closeClosing with reply_to_open (it emails candidates) happens in the app only.
hiring.applications.getNo pay expectations, private notes or file links.
hiring.applications.hire_draftThe pay suggestion is hidden; the hire itself happens in the app.
hiring.referrals.listReferral bonus amounts are hidden.
hiring.offers.getNo pay, range, approver context or file links.
hiring.offers.listNo pay.
hiring.letters.previewSample terms only: previews of a real offer stay in the app.
training.records.listNever certificates or the reasons HR declined a report.
training.records.getNever certificates or the reasons HR declined a report.
surveys.results.getGroups under the survey's threshold are hidden, the same as in the app.
surveys.results.responsesNamed surveys only: a confidential survey never shows one person's answers to anyone, machines included.
talent.settings.getWithout the works council checklist.
talent.reviews.listStatuses only (to do, done, left): never answers, ratings or who gave feedback.
talent.goals.listCompany, team and shared goals only; never private personal goals.
talent.goals.getCompany, team and shared goals only.
talent.profile.getYour own profile without certificate numbers; someone else's only when they show it to colleagues, as colleagues see it.
talent.profile.entries.addCertificate 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).
talent.profile.entries.updateCertificate numbers (credential_id) are refused; a stored number is kept as it is. Someone else's profile only when it is shown to colleagues.
comp.cycles.listNames, dates and stage only: never pay, people or proposals.
comp.bonus.plans.listNames, dates and status only: never pay, people or awards.
migration.startPasted CSV of at most 250 people; files and API connections in Bizisy.
migration.checkPay, payroll identifiers, sex and private details are refused; only moves the key started.
migration.itemsPrivate and pay cells are hidden.
migration.fix_itemsOnly moves the key started; private and pay cells are kept as they were.
migration.importAt most 250 people, people only, inside the call; only moves the key started.
webhooks.endpoints.listEach url shows its host only (the path is often the receiver's secret).
webhooks.endpoints.getThe url shows its host only.
webhooks.endpoints.updateOnly turning an endpoint off, its description and removing event types; a new URL, more events or turning it on happen in the app. The url in the result shows its host only.
webhooks.subscriptions.createFor Zapier, Make and n8n over an API key; refused for AI assistants (MCP) and apps connected by signing in.
webhooks.subscriptions.listEach url shows its host only (the path is the receiver's secret).
country.notices.listPay change notices (they reveal a pay change) are left out.
country.facts.getPerson country data is left out.
country.facts.setPerson country data (nationality, education level, place of birth) is refused; company codes are allowed.
country.relatorio_unico.readinessThe records to fix come with their ids only, never names.
country.relatorio_unico.annual.getWithout the names and numbers of health and safety staff and external services, and without work-accident counts.
country.relatorio_unico.providers.listWithout a self-employed provider's NIF, NISS and name, or any NISS.

Why#

  • AI assistants act for people, they don't replace them. An assistant can prepare a change and preview it, but approving a change, recording pay or switching approvals off needs the person.
  • A leaked key is bounded. A key that leaves your servers can't read anyone's bank details or home address, can't add a webhook that sends data somewhere new, and can't create more keys.
  • Exports of private data happen in the app, where the person sees what they download.

Machines in Activity#

Everything a machine changes shows in Activity with the key's or the app's name. Through MCP, previews (dry runs) and failed attempts are recorded too, so you can see what an assistant tried, not only what it did.

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs