API scopes

Learn how API access scopes work.

Overview

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.

ResourceDescriptionScopes
AgreementsDocuments signed electronically at sign-inagreements.read
BadgesBadge details for visitors/employeesbadges.read
CompaniesDetails about the accountcompanies.read
EmployeesUser records in the employee directoryemployees.read employees.write
EntriesVisitor/employee sign-in detailsentries.read
FlowsDetails about the steps a visitor/employee completed during sign-inflows.read
InvitesData about email invitations sent to visitors/employeesinvites.read invites.write
LocationsThe details about the place where visitors/employees sign-inlocations.read
Sign-in-FieldsThe form fields completed by visitor/employeessign-in-fields.read
SpacesData about a deskspaces.read
ReservationsData about a desk bookingreservations.read reservations.write
Audit logsAudit change log eventsauditlogs.read

📘

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


Did this page help you?