API scopes

Learn how API access scopes work.


Scopes are required for all apps types. You can add, view, or update your granted access scopes from the Integration Builder.

During the install process for listed and unlisted apps, the user will be asked to authorize those scopes. If the user authorizes your app you will receive a valid, scoped token to make API calls with on behalf of the company.

Access scopes

Scopes control access to resources in the API. Your app can ask for any of the access scopes listed below.

Resource Description Scopes
Agreements Documents signed electronically at sign-in agreements.read
Badges Badge details for visitors/employees badges.read
Companies Details about the account companies.read
Employees User records in the employee directory employees.reademployees.write
Entries Visitor/employee sign-in details entries.read
Flows Details about the steps a visitor/employee completed during sign-in flows.read
Invites Data about email invitations sent to visitors/employees invites.readinvites.write
Locations The details about the place where visitors/employees sign-in locations.read
-Fields The form fields completed by visitor/employees sign-in-fields.read
Spaces Data about a desk spaces.read
Reservations Data about a desk booking reservations.readreservations.write
Audit logs Audit change log events auditlogs.read

Your app must only request the minimum scopes that it needs to function. See ourapp guidelinesto learn more.

Did this page help you?