Scopes

As part of your application registration, you must provide the scopes your app requires.


For public integrations when your app is requesting authorisation from a user it will need to ask for a set of scopes. These scopes will be displayed to the user and describe what data your app will be able to access.

Whether you are a private or public integration you should request the minimum scopes required for whatever action that your organisation is performing. Later, if you find your organisation requires additional scopes you can request them by emailing api@flexitime.works.

Offline access

To get a refresh token, you must request the offline_access scope. A refresh token allows you to refresh your access token and maintain an offline connection.

offline_access

Organisation scopes

View and manage company settings

View company settings

View and manage employee basic information

View employee basic information

View and manage employee pay information

View employee pay information

View and manage all employee information

View all employee information

View and manage employee leave balance information

View employee leave balance information

View employee payslips

View employee pay history

View and manage team information

View team information

View and manage employee leave requests

View employee leave requests

View and manage pay items

View pay items

View and manage employee time entries

View employee time entries

View and manage employee work

View employee work

View and manage leave type information

View leave type information

View and manage pay cycle information

View pay cycle information

View and manage employee expense information

View employee expense information

company

company.read

employee_info

employee_info.read

employee_pay

employee_pay.read

employee_all

employee_all.read

employee_leave

employee_leave.read

employee_payslip

employee_pay_history

team

team.read

leave

leave.read

pay_item

pay_item.read

time

time.read

work

work.read

leave_type

leave_type.read

pay_cycle

pay_cycle.read

expense

expense.read