Action

Description

Required scopes

Get Effective Availability

Get the day-by-day merged availability projection for users

Get Ongoing Availability

Get each user's active and upcoming ongoing availability patterns

List Availability Requests

List each user's individual availability requests

List Clockins

List raw clock ins within a date range, filtered by user and/or device

Get Clockin

Retrieve a single clock in by ID

Create Clockin

Post a real-time clock in or out for a user

List Departments

List all teams (departments) in the organisation

Get Department

Retrieve a single team (department) by ID

List Devices

List the organisation's active physical time-clock devices

Get Device

Retrieve a single time-clock device by ID

Return Device

Mark a time-clock device as returned

List Leave

Look up multiple leave requests in a single request

Get Leave

Retrieve a single leave request by id

List Leave Types For User

List the leave types accessible for a specific user

Get Leave Hours Between

Get a recommended number of leave hours for a user across a date range

Create Leave Request

Create a leave request for a user

List Leave Balances

Look up leave balances for one or more users

Get Leave Balance

Retrieve a single leave balance by id

Update User Leave Balance

Update or set a user's leave balance

Predict Leave Balance

Predict what a leave balance will be on a future date

List Locations

List all locations in the organisation

Get Location

Retrieve a single location by ID

List Organisations

List the client organisations you manage

Get Organisation

Retrieve a single organisation by ID

Get Current Personal Details

Get the personal details of the currently authenticated user

Get User Personal Details

Get the personal details of a specific user by ID

List Public Holidays

Look up public holidays for regions and years

List Qualifications

List all qualifications defined in the account

Get Qualification

Retrieve a single qualification by ID

Get Roster

Get a roster by id

Get Current Roster

Get the current roster

Get Roster On Date

Get the roster that contains a date

List Schedules

Get multiple schedules by id

List Schedules By User

Get schedules for one or more users within a date range

Create Schedule

Create a schedule

Get Schedule

Get a schedule by id

Update Schedule

Update a schedule

Delete Schedule

Delete a schedule

Publish Schedules

Publish multiple schedules at once

Get Settings

Retrieve account-level system settings

List Shift Details

List shift details across the organisation

Get Shift Detail

Retrieve a single shift detail by its ID

List Shifts

List worked shifts filtered by shift IDs, user IDs, or a date range

Get Shift

Retrieve a single worked shift by its ID

List Active Shifts

List shifts currently in progress right now

List Shift Breaks

List all breaks belonging to a specific shift

Get Shift Break

Retrieve a single break within a shift

Get Shift Limits

Get the earliest and latest shift for the given users

Create Shift

Create a worked shift for a user on a specified date

Update Shift

Update a worked shift by its ID

Delete Shift

Delete a worked shift by its ID

Create Shift Break

Add a break to an existing shift

Update Shift Break

Update an existing break on a shift

Get Current Timesheets

Get the current-period timesheets

Get Timesheets On Date

Get all timesheets whose pay period includes a date

Get Timesheet

Get a timesheet by id

Update Timesheet

Change a timesheet's status

Get User Current Timesheet

Get a specific user's current-period timesheet

Get User Timesheet On Date

Get a specific user's timesheet whose pay period includes a date

List Unavailability

Look up multiple unavailability records in a single request

Get Unavailability

Retrieve a single unavailability record by id

List User Pay Fields

List all pay field records across every user in the organisation

Get User Pay Field

Retrieve a single pay field record by its ID

List Pay Fields For User

List all pay field records for a specific user

Create User Pay Field

Create a new pay field entry for a user

Update User Pay Field

Update an existing pay field entry by ID

Delete User Pay Field

Delete a pay field entry by ID

Get Current User

Get information about the currently authenticated user

List Users

List all visible users (employees)

List Inactive Users

List inactive (deactivated/terminated) users

Get User

Get information about a specific user by ID

List Clocked In Users

List staff who are currently clocked in at work

List User Alternate Rates

List a user's alternate (team-based) hourly rates

Invite User

Send an existing user an email invite to use Tanda

Onboard New Users

Invite a new staff member into Tanda's onboarding flow

Create User

Create a new employee (user)

Update User

Update an existing employee (user)

Delete User

Deactivate an employee (marks the user inactive)