Sign in

Permissions and access

The token's permissions and the person's own access, together.

What a request may do is decided twice: by the permissions the token carries, and by the person's own access. It needs both.

TokenCarries invoice.write?
RoleTheir role may make invoices?
Branch & territoryThat customer and branch are theirs?
ApprovalsOver a limit? It waits for an approver.

So a sales rep's token with invoice.read lists only the invoices of their branches and territory, exactly as their ZiloInvoice pages do; an accountant's token sees more. A permission is a ceiling, never more than the person has.

What each answer means#

  • 403 insufficient_scope: the token lacks the permission (details.scope says which). Ask for it when signing in.
  • 403 forbidden: the person's role doesn't allow it. No token fixes that; an admin changes roles in Control.
  • 404 not_found: nothing with that id that this person can see (another branch's invoice looks the same as one that doesn't exist).
  • 202: it waits for approval (see Approvals).

All permissions#

Ask only for what your app uses: the consent screen lists them, grouped by app. Apps with API permissions always get refresh tokens.

ZiloMail#

mail.readRead mailMailboxes, folders, messages, attachments and what changed.
mail.writeOrganise mailMark read or starred, move, delete, folders and drafts.
mail.sendSend mailSend email and check delivery status.

Calendar#

calendar.readRead calendarEvents in their calendar.
calendar.writeManage calendarAdd, change and remove events (guests are invited by mail).

Contacts#

contacts.readRead contactsTheir address book.
contacts.writeManage contactsAdd, change and remove contacts.

ZiloDrive#

drive.readRead ZiloDriveList, search and download files and folders.
drive.writeWrite ZiloDriveUpload files (virus-scanned), make folders, rename, move and move to Trash.

People#

users.readRead peopleThe organisation's people: names, addresses, job titles.

ZiloInvoice#

invoice.readRead salesCustomers, products, invoices and receipts.
invoice.writeRecord salesAdd and change customers and products, make invoices, record receipts.

ZiloInventory#

inventory.readRead stockWarehouses and stock on hand.

ZiloHR#

hr.readRead HREmployees, attendance and leave.
hr.attendanceMark attendanceMark attendance and record check-in / check-out.
hr.leaveAsk for leaveApply for leave (it goes through the usual approvals).

ZiloCRM#

crm.readRead CRMLeads, deals and activities.
crm.writeManage CRMAdd and change leads and deals, log activities.

ZiloProjects#

projects.readRead projectsProjects and tasks.
projects.writeManage tasksAdd and change tasks.

ZiloDesk#

desk.readRead ticketsSupport tickets and their conversations.
desk.writeWork on ticketsOpen tickets, reply, change status, priority and who has them.

users.write (adding people) is for organisation keys only, on the first API. Organisation admins manage people in Control.