API reference
API reference
On this page
Every action of the Bizisy API, 1196 in all. This reference is generated from the same action definitions that serve the API, the OpenAPI file and the MCP servers, at every build: it can't describe an action that doesn't exist or miss one that does.
Calling an action#
HTTP
POST https://api.bizisy.com/v1/<module>/<action>
Authorization: Bearer hrk_…
Content-Type: application/json
{ …input… }- Success is
200with the result underdata:{"data": …}. - Reads also answer
GET, with the input as query parameters (JSON-encode objects and arrays), unless an input field carries a secret. - Writes take
?dry_run=trueto preview and anIdempotency-Keyheader to make retries safe. - Errors share one envelope with a
code, amessageand ahint. - Inputs are strict: an unknown field is a
validation_failed, with the accepted fields in the hint.
Reading an entry#
- Who can call it: the key audiences (Manage, Me) and roles the action allows, worked out from its permission rule. Web app only marks actions no key or connected app may call; Keys and apps states a limit that applies to them.
- MCP tool: the same action as a tool, and the servers that offer it.
- Input and Returns: every field with its type, constraints and description. Nested objects fold open.
- Examples:
curl, Node (18 or later, built-infetch) and Python (requests), with the request a real client would send, and the response. Examples come from one sample company (ids such asp1are illustrative): the response repeats what its request sent, and shows what an HR Manage key gets when it reads someone else, so private and pay fields come backnull.
Platform#
- Account and API keysWho you are, your API keys, your connected apps and your language.11 actions
- Members and rolesEveryone with access to the company, their roles (built-in and custom), outsiders' end dates, linking logins to people, and your partner firms' access (Partner access).17 actions
- ActivityThe record of every change, with who made it and through what.5 actions
- Company settingsColours and logo, sign-in methods, company language, account status, storage and the data processing agreement.16 actions
- NotificationsYour in-app notifications, and which optional notices the company also emails.5 actions
- Push notificationsPush notifications per device (a browser or the installed app): availability, turning a device on or off, your devices and preferences, a test. Turned on in the app; machines are refused.6 actions
- Plan and billingThe company's plan (nothing to pay up to 9 active people, then one price per active person, every module included), the modules and features it switched on or off (AI and API access), emails, storage and AI credits, billing details, invoices and paying them, and promotion codes.15 actions
- Apps and the marketplaceThe marketplace listings, the apps installed in your company, the developer organization linked to it, and what an installed app calls about its own install.14 actions
Organization#
- Setup and importSet up a whole company in one call, set up a module the company switched on (its decisions, recommended defaults and progress), or import people from a CSV: matched to your columns, checked person by person, bad rows parked to fix later.19 actions
- Units, locations and legal entitiesDivisions, departments and teams, the places people work and the companies that employ them.22 actions
- PeopleThe directory, finding anything by name, queries over people, one person's profile, profile changes and photos, and bank account changes with a proof (Verified bank details).25 actions
- Saved groupsNamed people criteria that update themselves: filter people and the org chart, scope custom roles, choose who gets a checklist.6 actions
- Jobs and employmentHire (with starting pay and a scheduled invite), change jobs from a date, terminate (and say whether the person has been told), rehire, correct job history, and save any of it for later.13 actions
- Self-serviceA person's own profile, team, photo, data export, how pay is set and requests about pay levels, and people joining your team (Me keys).19 actions
- Org chartThe org chart on any date, as nodes or as a list.3 actions
- Invites and outside accessInvite people by email alone (they add their own details), invite people to sign in, give outsiders access with a custom role and an end date, list and revoke invites, and preview whom a role covers.12 actions
- Custom fieldsFields of your own on every person, each with a visibility tier.3 actions
- PayPay history. Reading your own pay works with a key; recording pay happens in the web app.4 actions
- Pay bands and pay equityPay bands, job evaluations, categories of workers, the pay gap, Art. 9 reports and answering Art. 7 pay requests (EU Pay Transparency Directive). Bands, gaps, reports and requests are pay data: the web app only, except your own band and your own requests.28 actions
- People analyticsOne measure (turnover by type, regretted and early attrition, stability, retention, tenure, absence, span of control, internal moves) across sites, teams and periods, with groups under the minimum size always hidden; saved views, downloads and the minimum group size. Diversity dimensions, and absence or regretted by group, are in the web app only.7 actions
- Exports, reports and erasurePeople as CSV, a person's data for an access request, the headcount, span of control and data quality reports, and erasing a former employee.7 actions
- Home, reminders and renewalsWhat needs attention today, the reminder emails before dates come up, company renewals and occupational health-check dates.19 actions
- 1:1s and quarterly check-insRegular 1:1s between a person and their manager (cadence, shared agenda, action items, a private note each) and quarterly check-ins (the company's questions, the person's answers, then the manager's). Over a key or AI app, only your own.33 actions
- AnnouncementsCompany announcements with acknowledgement: drafts for HR (publishing, corrections and the report stay in the web app), each person's own announcements and whether they confirmed them, and who may post. Webhooks: announcement.published and announcement.acknowledged, ids only.15 actions
- Job titlesThe job title catalog: titles grow as people type them; families, levels, merging duplicates and renaming.17 actions
- Open positionsRoles the company plans to fill and headcount budgets per team: the headcount plan.12 actions
- Workforce planningA forecast of headcount, FTE and cost per team and month, scenarios with planned hires, reductions and moves, comparing them, and the default assumptions.13 actions
- ApprovalsApproval rules and change requests: list, approve, reject and withdraw.7 actions
- CasesThe case list: everything that needs HR from every module, each with its evidence and a suggested fix to run; snooze cases or hand them to a colleague.2 actions
- Batches of job changesMove waves: the same job change for many people from one date — prepare from a filter or a list, preview who is ready or blocked, one grouped approval, apply (big batches in the background), announced on their day.10 actions
- Start groupsJoiner waves: the people who start together, followed person by person — contract signed, admission notice, Bizisy invite, onboarding checklist and mandatory training.5 actions
- People flowWho starts, leaves and moves on each day of a month (and the next two), in and out per team, with the month's batches and start groups.1 action
- Change setsSeveral changes as one, all or nothing, and drafts a person reviews and applies in Bizisy.5 actions
- Directory syncGoogle Workspace and Microsoft Entra: the connection, importing people once, what each sync sends (new accounts, changes, suspensions) and confirming new accounts. Connecting and confirming happen in the web app.13 actions
- Spend tools (Pleo, Moss, Payhawk, Spendesk)What Bizisy does in each spend tool its API allows (invites, teams or cost centres, approvers from team leads, blocking a leaver's cards), the plan before syncing starts and what HR does in the tool itself. Connecting, starting, confirming and excluding happen in the web app.7 actions
- Chat announcementsJoiner, team move and new title posts in Slack, Microsoft Teams, Google Chat, Mattermost, Discord or Rocket.Chat: status, the preview of each post, skipping one and trying a failed one again. Connecting, settings and test messages happen in the web app.9 actions
- Learning platformsTalentLMS, 360Learning, Docebo and Moodle: who Bizisy keeps in the platform and what the next sync does for each person (new accounts, changes, deactivations). Confirming or excluding people happens in the web app; connecting and settings are integrations. Course tasks are checklist tasks done in the platform.2 actions
- Google Calendar and Outlook CalendarThe first-day invites (and optional task due dates) Bizisy puts on the connected calendar for new hires: what is planned, what is on the calendar and when the rest goes out. The template is a connection setting; connecting happens in the web app.1 action
- ChecklistsOnboarding, offboarding and custom checklists: templates, runs and tasks, including tasks done in Jira, Jira Service Management, Linear or Asana (their record there, Sync now) and course tasks in TalentLMS, 360Learning, Docebo or Moodle; and the new-hire welcome page settings.17 actions
- Okta accountsWhat the next Okta run sends (new accounts, activations, changes, suspensions), the accounts linked to people, confirming and retrying, and the Okta groups to map teams and job families to. Confirming happens in the web app.5 actions
- SCIM tokensThe tokens identity providers use to read people and teams from Bizisy's SCIM 2.0 service, and what they see. Creating and revoking tokens happen in the web app.3 actions
- Hires from recruiting toolsCandidates hired in Teamtailor or Greenhouse waiting for HR, and the tool's departments for the team mapping. Adding, linking and dismissing happen in the web app.5 actions
migration#
hiring#
Documents#
- DocumentsCompany and person documents: list, upload, change, download and delete; categories.58 actions
- My documentsA person's own documents (Me keys).14 actions
- File fieldsFiles in custom fields of type file, for a person or yourself.5 actions
- E-signatureSend a person's document for signature through the company's own e-signature tool (Yousign, DocuSign, Dropbox Sign, Signaturit or Skribble; simple, advanced or qualified, eIDAS), follow it, remind, cancel and try again; signature levels per category and the tool in use; what waits for your own signature (Me keys). The signed copy and audit trail come back as documents.13 actions
assets#
- Equipment registerLaptops, phones, badges and cars: list, add, hand over, take back, import, retire, and the report by team; devices synced from Jamf Pro, Microsoft Intune, Kandji and Workwize are flagged for review.9 actions
- My equipmentA person's own equipment and confirming they received it (Me keys).2 actions
training#
- Training registerMandatory training rules and who is overdue (remind, exempt with a reason), courses and training records (add, import, confirm or decline what people reported), certificates in the app, each person's training hours where a country rule applies (Portugal: 40 hours a year, deferral, credit and what a leaver is paid for), the company summary, and LinkedIn Learning: find a course and assign it to people as tasks that tick themselves.30 actions
- My trainingA person's own training, hours and credit, and reporting training they did (Me keys read; reporting is in the app).2 actions
benefits#
- BenefitsThe benefits catalogue with each country's tax limits (add the usual ones per country), flexible plans per legal entity, enrolment windows, settings, and who has which benefit (in the app only).14 actions
- My benefitsA person's own benefits: what they have, their flexible budget and choices with the tax limits (Me keys read; choosing is in the app).2 actions
talent#
- Performance and talentReview cycles (who, template, dates, launch, progress, reminders), review templates and rating scales, reviews and their statuses, peer reviewers, and goals with their cascade and progress. Answers, ratings and who gave feedback are never available to API keys: reviews are written in the app.40 actions
- My reviews and goalsA person's own review to-dos, feedback requests and goals (Me keys read; reviews and feedback are written in the app).5 actions
- Career pathsPaths between job titles (add, change, remove, suggest the next level), a person's own career (current title, skill gaps, suggested courses, open internal jobs) and career interest (said in the app only).9 actions
- Talent profilesA 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
- Calibration, 9-box, succession and skillsCalibration sessions (population from a review cycle, facilitator, participants; moves, lock and reopen are in the app), potential, the 9-box, key positions with successors and bench strength, development actions, and the skills framework (catalog, skills required by job titles and given by courses, people's skills by source, gaps). Ratings, potential and succession are never readable by API keys or AI apps.39 actions
insights#
- Talent insightsTalent insights (an AI system under the EU AI Act): the numbered setup and the switch, the worker notice, the DPIA template, the fairness check, problem reports, exclusions, explanation requests and the audit log. Bands, reviews and the people list are in the Bizisy app only (API keys and AI apps are refused).21 actions
- AI insights about meWhether a person's company uses Talent insights, the notice, their status, objecting and asking for an explanation (objecting and asking are in the app only). Never the band.3 actions
shifts#
- Shift rotasRotas per location or team: drafts filled from work schedules, another week or a template week; shifts placed, moved and checked against the working-time rules of PT, ES, DE and the EU Directive floor, each finding citing its article; suggestions for open shifts; history and prints (rota, mapa de horário, cuadrante). Publishing and approving requests are in the app (never API keys).36 actions
- My shiftsA person's own published shifts, open shifts to claim, swap and give-away requests, when they can't work and their shift emails (calendar feeds are created in the app).7 actions
surveys#
- SurveysSurveys and forms with pages, logic, piping, scoring and translations, named or confidential; send them to everyone, teams, locations, entities or saved groups, now or at a time; results by group within the confidentiality thresholds, CSV, XLSX, SPSS and JSON exports, a Google Sheets link, lifecycle surveys (start, exit, move, return), actions from results, a public link anyone can answer without signing in (with its embed, kiosk and abuse limits), themes with background images, AI drafts, question checks, comment themes and questions about results, and replies to comments that never identify their author.39 actions
- Surveys and works councilsEach survey's works-council pack (what it asks, who sees what, thresholds, retention, where the data goes, country notes with sources), the council's approval before sending (asked by HR, decided by a login with Surveys at Approve, in the app only) and the council's results by group, never one person's answers.5 actions
- My surveysThe surveys sent to a person and their saved answers (answering is in the app).12 actions
comp#
- Salary reviewsSalary review cycles: the population, dates, the merit matrix (rating × compa-ratio) and budgets, launch, HR review under the pay approval rules, the equity check, release and the payroll file. Pay stays in the app: API keys and AI assistants get cycle names, dates and stage only.22 actions
- Bonus plansBonus plans by a published formula (target % of base pay × company factor × individual factor from ratings and, when weighted, committed goals × share of the period worked, in cents), launch, managers' adjustments in %, HR approval under the pay approval rules, the equal-pay check by sex per category, release to payroll and letters. Pay stays in the app: API keys and AI assistants get plan names, dates and status only.14 actions
- My salary reviewA manager's worksheet (proposals in %, never salaries), the team leads' worksheets their own manager checks before HR, a person's letters once released, and the criteria published to staff (in the app, except the criteria).12 actions
timeoff#
- Time offBooking (preview, book, cancel), who's away, requests and approvals, balances, adjustments and imports, calendar feeds and the absence report. Others are "Away" only over API keys.21 actions
- Time off settingsLeave types, allowance policies per location with country defaults, working weeks, public holidays and company days, rules and approvals.24 actions
- Work schedules and work calendarsFixed, flexible and rotating schedules, who follows which from when, a person's schedule history, and each workplace's work calendar with its export (the Spanish calendario laboral).8 actions
timeclock#
- Time clockClocking in and out with breaks, today and time records, who's in, corrections with their history and approvals, overtime asked before it's worked and approved (or decided afterwards), month close and acknowledgement, the inspection export (registro de jornada), payroll hours and the monthly report. Machines: their own person at the current time; others only with machine consent for private data.27 actions
- Time clock settings and kiosksSwitching the time clock on, who approves corrections, location (off, record, geofence) and workplaces, reminders, retention and acknowledgement per country, and shared kiosks.5 actions
- Door terminalsDoor terminals that send punches: ZKTeco terminals over ADMS/PUSH on their own address (attendance logs only; never fingerprints, faces or photos), other brands and middleware through timeclock.punches.ingest (duplicate-safe, clock-skew tolerant, at most 100 events a call). Badge numbers mapped to people (CSV in batches of 500), and the To match list of unknown badges and punches a rule held back.13 actions
integrations#
accounting#
data#
payroll#
- PayrollPay periods per legal entity and their change sets (hires, leavers, changes, pay, variable pay), locking, exports for the payroll provider (Excel, CSV, JSON, DATEV LODAS, BrightPay), payslips, net pay and the SEPA salary file. Bizisy prepares payroll; it never calculates or files it.22 actions
- Payslips and attachmentsUpload payslips for a locked period (they become the person's documents), match the ones left over, and files for the accountant.12 actions
- Payroll toolsSend a locked pay period to Staffology, Xero Payroll (UK) or Silae: where each legal entity goes, the preview of what goes per person, the send (in the app, bound to the preview, with consent for pay and private data) and the log of what was sent.5 actions
- Meta4 bridgeThe codes Meta4 knows each leave type, pay item, time-clock total, leaving reason and contract type by (matched from a pasted code list), the preview of a locked period before its Meta4 file is made (payroll_exports_create, format meta4), and the reconciliation with Meta4's results.6 actions
- Machine access to pay dataConsents that let one API key, AI app, marketplace app or connector receive pay and private data, and revoking them.3 actions
country#
Webhooks#
Something missing or wrong on this page? Write to hello@bizisy.com.