> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workforce.com

> How to set up the Workforce.com connector, plus the actions that are available.

![Workforce.com](https://stackone-logos.com/api/workforce/filled/svg)

Betav0.3.0[See changelog](https://docs.stackone.com/connectors/workforce/changelog.md)

[78 actions](#actions) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/workforce/guides/connector-profile/access-token.md)
>
> Uses a long-lived personal access token generated in Workforce.com. The token is scoped to a single organisation and inh...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/workforce/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth application in Workforce.com. Access tokens expire after 2 hours and are refreshed automat...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/workforce/guides/link-account/access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/workforce/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

cost

department

device

leave

me

organisation

personal

qualifications

roster

settings

timesheet

unavailability

user

No scopes found

78 actions

ActionDescriptionRequired scopes

Get Effective Availability`workforce_get_effective_availability`

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

`unavailability`

Get Ongoing Availability`workforce_get_ongoing_availability`

Get each user's active and upcoming ongoing availability patterns

`unavailability`

List Availability Requests`workforce_list_availability_requests`

List each user's individual availability requests

`unavailability`

List Clockins`workforce_list_clockins`

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

`device`

Get Clockin`workforce_get_clockin`

Retrieve a single clock in by ID

`device`

Create Clockin`workforce_create_clockin`

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

`device`

List Departments`workforce_list_departments`

List all teams (departments) in the organisation

`department`

Get Department`workforce_get_department`

Retrieve a single team (department) by ID

`department`

List Devices`workforce_list_devices`

List the organisation's active physical time-clock devices

`device`

Get Device`workforce_get_device`

Retrieve a single time-clock device by ID

`device`

Return Device`workforce_return_device`

Mark a time-clock device as returned

`device`

List Leave`workforce_list_leave`

Look up multiple leave requests in a single request

`leave`

Get Leave`workforce_get_leave`

Retrieve a single leave request by id

`leave`

List Leave Types For User`workforce_list_leave_types_for_user`

List the leave types accessible for a specific user

`leave`

Get Leave Hours Between`workforce_get_leave_hours_between`

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

`leave`

Create Leave Request`workforce_create_leave`

Create a leave request for a user

`leave`

List Leave Balances`workforce_list_leave_balances`

Look up leave balances for one or more users

`leave`

Get Leave Balance`workforce_get_leave_balance`

Retrieve a single leave balance by id

`leave`

Update User Leave Balance`workforce_update_user_leave_balance`

Update or set a user's leave balance

`leave`

Predict Leave Balance`workforce_predict_leave_balance`

Predict what a leave balance will be on a future date

`leave`

List Locations`workforce_list_locations`

List all locations in the organisation

`department`

Get Location`workforce_get_location`

Retrieve a single location by ID

`department`

List Organisations`workforce_list_organisations`

List the client organisations you manage

`organisation`

Get Organisation`workforce_get_organisation`

Retrieve a single organisation by ID

`organisation`

Get Current Personal Details`workforce_get_current_personal_details`

Get the personal details of the currently authenticated user

`personal`

Get User Personal Details`workforce_get_user_personal_details`

Get the personal details of a specific user by ID

`personal``user`

List Public Holidays`workforce_list_public_holidays`

Look up public holidays for regions and years

List Qualifications`workforce_list_qualifications`

List all qualifications defined in the account

`qualifications`

Get Qualification`workforce_get_qualification`

Retrieve a single qualification by ID

`qualifications`

Get Roster`workforce_get_roster`

Get a roster by id

`roster`

Get Current Roster`workforce_get_current_roster`

Get the current roster

`roster`

Get Roster On Date`workforce_get_roster_on_date`

Get the roster that contains a date

`roster`

List Schedules`workforce_list_schedules`

Get multiple schedules by id

`roster`

List Schedules By User`workforce_list_schedules_by_user`

Get schedules for one or more users within a date range

`roster`

Create Schedule`workforce_create_schedule`

Create a schedule

`roster`

Get Schedule`workforce_get_schedule`

Get a schedule by id

`roster`

Update Schedule`workforce_update_schedule`

Update a schedule

`roster`

Delete Schedule`workforce_delete_schedule`

Delete a schedule

`roster`

Publish Schedules`workforce_publish_schedules`

Publish multiple schedules at once

`roster`

Get Settings`workforce_get_settings`

Retrieve account-level system settings

`settings`

List Shift Details`workforce_list_shift_details`

List shift details across the organisation

`department`

Get Shift Detail`workforce_get_shift_detail`

Retrieve a single shift detail by its ID

`department`

List Shifts`workforce_list_shifts`

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

`timesheet`

Get Shift`workforce_get_shift`

Retrieve a single worked shift by its ID

`timesheet`

List Active Shifts`workforce_list_active_shifts`

List shifts currently in progress right now

`timesheet`

List Shift Breaks`workforce_list_shift_breaks`

List all breaks belonging to a specific shift

`timesheet`

Get Shift Break`workforce_get_shift_break`

Retrieve a single break within a shift

`timesheet`

Get Shift Limits`workforce_get_shift_limits`

Get the earliest and latest shift for the given users

`timesheet`

Create Shift`workforce_create_shift`

Create a worked shift for a user on a specified date

`timesheet`

Update Shift`workforce_update_shift`

Update a worked shift by its ID

`timesheet`

Delete Shift`workforce_delete_shift`

Delete a worked shift by its ID

`timesheet`

Create Shift Break`workforce_create_shift_break`

Add a break to an existing shift

`timesheet`

Update Shift Break`workforce_update_shift_break`

Update an existing break on a shift

`timesheet`

Get Current Timesheets`workforce_get_current_timesheets`

Get the current-period timesheets

`timesheet`

Get Timesheets On Date`workforce_get_timesheets_on_date`

Get all timesheets whose pay period includes a date

`timesheet`

Get Timesheet`workforce_get_timesheet`

Get a timesheet by id

`timesheet`

Update Timesheet`workforce_update_timesheet`

Change a timesheet's status

`timesheet`

Get User Current Timesheet`workforce_get_user_current_timesheet`

Get a specific user's current-period timesheet

`timesheet`

Get User Timesheet On Date`workforce_get_user_timesheet_on_date`

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

`timesheet`

List Unavailability`workforce_list_unavailability`

Look up multiple unavailability records in a single request

`unavailability`

Get Unavailability`workforce_get_unavailability`

Retrieve a single unavailability record by id

`unavailability`

List User Pay Fields`workforce_list_user_pay_fields`

List all pay field records across every user in the organisation

`cost`

Get User Pay Field`workforce_get_user_pay_field`

Retrieve a single pay field record by its ID

`cost`

List Pay Fields For User`workforce_list_pay_fields_for_user`

List all pay field records for a specific user

`cost`

Create User Pay Field`workforce_create_user_pay_field`

Create a new pay field entry for a user

`cost`

Update User Pay Field`workforce_update_user_pay_field`

Update an existing pay field entry by ID

`cost`

Delete User Pay Field`workforce_delete_user_pay_field`

Delete a pay field entry by ID

`cost`

Get Current User`workforce_get_current_user`

Get information about the currently authenticated user

`me`

List Users`workforce_list_users`

List all visible users (employees)

`user`

List Inactive Users`workforce_list_inactive_users`

List inactive (deactivated/terminated) users

`user`

Get User`workforce_get_user`

Get information about a specific user by ID

`user`

List Clocked In Users`workforce_list_clocked_in_users`

List staff who are currently clocked in at work

`user`

List User Alternate Rates`workforce_list_user_alternate_rates`

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

`user`

Invite User`workforce_invite_user`

Send an existing user an email invite to use Tanda

`user`

Onboard New Users`workforce_onboard_new_users`

Invite a new staff member into Tanda's onboarding flow

`user`

Create User`workforce_create_user`

Create a new employee (user)

`user`

Update User`workforce_update_user`

Update an existing employee (user)

`user`

Delete User`workforce_delete_user`

Deactivate an employee (marks the user inactive)

`user`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.