Skip to content

Build an app

App scopes

On this page

Scopes say what your app may do in a company. Ask for the fewest you need: the consent page shows each one in plain words, and owners and admins decide on that.

ScopeWhat it allows
people:viewSee people and their jobs: profiles, job titles, teams, managers, start dates and job history. Not private details or pay.
people:proposePropose hires and job changes; they wait for someone in the company to approve them.
people:editHire, update profiles, change jobs and record leavers. The company's approval rules still apply.
documents:viewCompany documents, and the title, category and date of people's documents (their files need private:read).
documents:editUpload, replace and delete documents.
checklists:viewOnboarding and offboarding checklists and their tasks.
checklists:editStart checklists, complete and assign tasks, change templates.
positions:viewOpen and planned positions and their budgets.
positions:editOpen, plan and close positions.
pay_equity:viewJob architecture, pay bands and pay gap reports (no one's individual pay).
pay_equity:editJob families, levels and pay bands.
payroll:viewPay periods, what changed in them, exports and payslips. Pay amounts and private details also need pay:read or private:read, and an owner, admin or HR consent (given at install).
payroll:editPrepare pay periods: variable pay, notes, imports, locking and exports. Approval rules still apply.
structure:editTeams, locations, legal entities, job titles and custom fields.
activity:viewWho changed what in Bizisy, and when.
private:readSpecial. Home address, personal contacts, birthday, emergency contacts, tax and social security numbers, bank account, and the files of people's documents.
pay:readSpecial. Salaries, pay history and variable pay of everyone.

Always included: every install can read what every employee sees, the company directory (names, job titles, teams and work email).

Special scopes#

private:read and pay:read are never granted by default. The consent page shows them with a warning, and an owner or admin must tick a box to allow them. Without them, your app is a machine like an API key: it never receives other people's private details or pay, whatever else it may do (What machines can see). Installing an app with a special scope also records the matching consent in Payroll → Settings → Machine access (pay for pay:read, private data for private:read), so payroll answers it with values; uninstalling the app, or installing a version without the special scope, revokes that consent.

What no app can do#

Approve changes (approvals stay with people), record or change pay, manage the company's members, sign-in, billing, webhooks, API keys or other apps, or anything that is done in the web app only.

Asking for more later#

A new version that asks for more scopes needs Bizisy's review. Companies that installed an earlier version keep what they consented to; their Installed list shows that your app wants more access, and an owner or admin reviews it by installing again.

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

Developer docs