# Client Orders
Source: https://docs.roostedhr.com/guides/clients/client-orders
How you clients can place their orders?
Client orders are placed by your customer through the Client Portal. From the Client Orders, you can see order details: the date of the ordered event, when the order was placed, the client's name, and information about what is required with the order.
## Searching & filtering orders
You can manage and view orders using the following features:
* **Search by Order Name:** Type into the search bar to find specific orders.
* **Filter Orders:** Click the order type dropdown to filter by:
* **ALL ORDERS**
* **NEW ORDERS**
* **Sort Orders:** Click the order event dropdown to sort by:
* **Event Date Oldest First**
* **Event Date Newest First**
* **Order Placed Oldest First**
* **Order Placed Newest First**
## Order Details
All placed orders will display the following information:
* **NAME:** The name associated with the order.
* **LOCATION:** The location of the event.
* **DATE PLACED:** When the order was placed.
* **EVENT DATE:** The date of the event.
* **INTERNAL ORDER ID:** The unique identifier for the order.
* **ORDER PLACED:** Details of the order.
* **ORDER:** Additional specifics related to the order.
The status of the order will also be shown. For example, in the display below, the order is marked as **NEW**. Clicking Order Details will open additional information:
**1. The exact location:**
**2. Any comments from the client:**
**3. And the option to accept or decline the order:**
## Accepting an order
To accept an order:
1. **Click** "Accept Order."
2. **Confirm** by clicking "Accept Order" again.
This action will:
* Send an email notification to the client.
* Create an event with all unpublished shifts, allowing you to make any necessary changes.
Back on the Client Orders page, you will see that the order has been approved which will appear in a green box.
## Declining an order
1. **Click** "Decline Order."
2. **Confirm** by clicking "Decline Order" again.
This will send an email to the client informing them that the order has been declined.
On the **Client Orders** page, you will see that the declined order is marked with a red box, indicating its status.
And that's how you use the Client Orders page in Roosted.
# Client Portal
Source: https://docs.roostedhr.com/guides/clients/client-portal
Welcome to the client portal article in Roosted! The client portal is an easy way for your customers to submit and track orders and provide feedback on previously scheduled events. When the client accepts the invitation, they will be asked to create a username and password to log in to the portal. In case of a forgotten password, it won't be possible to reset it from the client's view. To reset the credentials, please open a support ticket. When logged in, your client can edit their details by clicking the user icon in the top right corner -> User Profile.
From this view, personal data can be adjusted.
From the main page, the client can submit new orders, see a list of their placed orders or change any of the information through the settings page.
## Submitting New Orders
To submit a new order the Event Name, Date, Location name, and Address must be filled. Optionally, order ID, and comments sections can be submitted. The clients can also add, modify, and delete shifts to their orders.
**Adding a shift** Adding a shift is easily done by clicking the "add shift" button, and selecting from the dropdown a skillset to be added.
**Adjusting a shift** When a shift has been added, the client can easily change the quantity of workers needed, or enter the start time and optional ending time.
**Deleting a shift** To delete an added shift, just click on the red "trashcan" button located on the right side.
When all information has been entered, your client can hit SUBMIT ORDER.
When the client clicks SUBMIT ORDER, it will appear as a new order in your CLIENT ORDERS from the Admin's side.
## Orders
From the orders page in the List view, clients can easily track their current, new, and past orders. For the past ones, the feedback on workers can also be added. **Tracking an order** At the top of this page, clients can search orders by name, type, or sort according to their needs. After choosing an event, the details entered while creating the event will be shown.
For more info click Order Details:
The Client Portal will include orders that the customers have placed but also orders that you have placed on their behalf. If you assign a client to a newly created event, it will also be shown in the Client's Portal.
**Feedback** Clients can also provide feedback on workers who have worked at their events. Click on Order Details on a passed event to see a list of workers who worked that day. Here the workers can be evaluated - thumb up will mark them as preferred, and thumb down as banned. When a client evaluates a worker, it is visible only as a suggestion. An admin or owner-level account will be able to either accept or ignore this feedback.
Please check our latest video which will bring you more insights to the topic!
And that is how the Client Portal works through Roosted! π€
# Client Signature
Source: https://docs.roostedhr.com/guides/clients/client-signature
How to use the Client Signature feature to obtain signatures from clients or senior staff members at the end of an event?
In this article, we'll cover how to use the Client Signature feature to obtain signatures from clients or senior staff members at the end of an event.
## Overview
The Client Signature feature is a valuable tool for both invoice tracking and billing, as well as for confirming the completion of an event. You can attach a client to each event you create, making it easier to gather signatures for verification and record-keeping purposes. This feature supports two primary uses:
1. **Client Signature**: Obtain a signature from the client if they are physically present at the event.
2. **Senior Staff Signature**: Obtain a signature from a senior member of staff (e.g., a Captain) if the client is not present.
## How to Obtain a Signature
1. **Client Signature**:
* The Event Time Tracking Manager, Admins, or Owners can collect a signature from the client at the end of the shift.
* If the client is present, you can simply tap **Client Approval**. The system will prompt you to confirm this action, as it will lock all-time punches for the event.
2. **Senior Staff Signature**:
* If the client is not available, you can obtain a signature from a senior staff member. This ensures that event completion is still documented and verified.
## Steps to Collect a Signature
1. **Attach a Client to the Event**:
* When creating an event, attach the client to facilitate invoice tracking and billing. This also helps in obtaining their signature post-event.
2. **Initiate the Signature Process**:
* At the end of the shift, access the event details.
* Tap **Client Approval** (or the relevant option for senior staff).
* Confirm the action when prompted. This will lock the time punches and finalize the event documentation.
By using the Client Signature feature, you ensure that all necessary approvals are secured, enhancing accountability and streamlining your billing process.
Once you tap the **Show Approval Screen**, you'll be prompted to hand the device to the client for their review and signature. On this screen, the client will see:
* **List of Worker Names**: A detailed list of all workers involved in the event.
* **Time Punches**: Records of start and end times for each worker.
* **Total Hours**: A summary of total hours worked, calculated at the top of the page.
The client can review this information and provide their signature directly on the device to complete the approval process.
When the client is ready to sign, they should follow these steps:
1. **Click "Sign"**: This will prompt them to enter their name and add any optional comments.
2. **Click "Next"**: The screen will rotate, allowing the client to write their signature directly into the designated box.
3. **Submit**: After entering their signature, the client should click **Submit**.
Once the submission is complete, the client will be prompted to return the device.
If you prefer to have a senior staff member (e.g., a Captain) review and sign off at the end of an event instead of the client (if the client is not physically present), follow these steps:
1. **Event Time Tracking Manager**:
* Use the same process as outlined above for the client signature.
* Instead of involving the client, the senior staff member will review the details and provide their signature directly.
## Client Signature Settings
You can enable or adjust the Client Signature settings according to your preferences by navigating to:
* **Configuration** -> **Settings** -> **Time Tracking** -> **Client Signature**.
Here, you can turn the Client Signature feature on or off and make any necessary adjustments. See **[Client Signature Settings](https://support.roostedhr.com/en/articles/9491788-client-signature-settings)** for more information. And this is how you can use Client Signature through Roosted! π
# Clients
Source: https://docs.roostedhr.com/guides/clients/clients
Clients and how to manage their profiles.
Clients are all of your customers that can be assigned to events. Store information about your clients in their profile - billing information, custom fields, and much more. The client list is in the Admin bar on the left side. It's easy to create, search, edit, import, and delete clients.
## How to create clients?
To add a new client, click Create Client and enter the details. After that, they will appear on the main clients page.
## Editing a Client
Click the wrench on the client and enter/change information as needed: the Client Name, Address, or any custom fields that were created. We can also add additional company contacts under the Additional Contacts box.
## Preferred & Banned workers
If a worker is on a client's preferred list, they will automatically be given preference for future shifts created for that client. Conversely, if a worker is on the banned list, they will be prohibited from participating in any events for that client.
Owners and Admins can drag and drop workers to and from the Preferred or Banned list. Clients can also suggest to prefer or ban a worker through the Client Portal.
## Default Event Comments
Event comments are notes that can be applied to all future events created for a client. Workers assigned to these events will be able to see these comments on their "Available" and "My Shifts" pages.
## Default Rules & Tags
Rules and tags help narrow down the pool of workers for a shift. Custom field rules applied to workers can also be set up for a client - these will automatically be applied to shifts created for that client in the future.
When we apply rules and create an event, they will show like this on the event page.
## Client Portal
The Client Portal is a system that your client can use to submit orders or add feedback on workers who worked events. You can invite the client to use the client portal by clicking Actions - Invite Client to Client Portal
Enter the email address to send the invitation and include a welcome message or further information.
If you have entered the email address incorrectly, resend the invite by clicking Actions - Invite Client to Client Portal and enter the correct email address - the previous invite will be canceled. One email address per client can be invited: If multiple users need access to the Client Portal, it is recommended that the client create a general username and password that can be used by several users simultaneously. The client will receive an email (similar to the one shown below) prompting them to create a username and password for login.
When your client clicks 'Go to Client Portal,' they will be prompted to enter their address details and then click 'Create account' to complete the process.
Once the request has been sent and the client accepted it and signed up, the information will show by the sign-up date. If they have not signed up yet, the invitation date will show.
## Deleting a client
Deleting a client can be done by clicking Actions - Delete Client
After deleting a client, any previously scheduled events won't be affected, but you will not be able to use this client anymore. And that is the Client section through Roosted! π€
# Announcement & Chats
Source: https://docs.roostedhr.com/guides/communication/announcement-chats
Announcements & Chats for the best communication with your workers.
In this article, we will explain how you can use Announcements & Chats to communicate information to your workers. When logged as an admin or owner, you can click the chat bubbles in the top right and pop up window will appear:
You will be able to see **Notifications & Announcements** as well as a list of all the chats that you have created or are added to.
## Creating a new chat
To create a new chat just click + Chat button. You can filter the participants you want to add by skillsets or name. To add a person to the chat, just tick the box next ton their name.
If creating the chat, you will be automatically added as a participant. After adding workers, you can name the chat box and see the list of workers that have been selected.
By clicking on the wrench icon, the chat can be edited - the participants and the name previously selected. You can also turn off the notifications by clicking the bell icon. To start the chat just send a message - below it, you will see an exact sending time.
You can also delete a chat by clicking the trash can on the top right side.
## Creating a new Announcement
To create an Announcement click + Announcement button. You can choose to send it to Everybody or only to particular skillsets. You can also send SMS by clicking the checkbox to the right.
When creating the announcement, you can define where the replies will be sent to - admin or an account owner. Chat replies apply to **PUSH NOTIFICATIONS ONLY**. Replies received by email will be directed to the HR email listed on your HR section which can be found by navigating to Configuration -> **Company Info**.
You can enter the title and add the message itself in the designated area - you can also add links and pictures, that will be distributed to all people at once.
Clicking Send will confirm the operation and when successful, you will see a green box in the right top corner. You can view a list of your sent announcements from your **Communication Center** by entering Configuration -> Communication Center -> SENT GROUP MESSAGES. By default, the announcements will be sent by email & push notification - **if you select 'Also send by SMS' it will only send it to where the push notification cannot be received** - the worker has disabled push notifications or has not downloaded the app.
## Event Chats
Event Chats are another way of forwarding information to your workers scheduled for an event. You can quickly and easily send last-minute information to chosen, or all workers. Please see **Event Chats** for more information! Please check our new video with all the details explained in 1 minute!
This is how you can use Announcements & Chats to communicate information to your workers through Roosted! π
# Calendar Sync
Source: https://docs.roostedhr.com/guides/communication/calendar-sync
Sync your Google, Apple or other calendar with Roosted for even better experience!
Roosted supports the ability to sync your Roosted calendar with your personal calendar, whether is Google Gmail, Apple, or any iCal-compatible calendar or device.
The update frequency of your personal calendar depends on the service you use,
so the information may not always be up-to-the-minute. For instance, Google
and Gmail calendars may be updated with a delay of up to 12 hours, while Apple
calendars tend to refresh more frequently. For the most current and real-time
information, always recommend that workers check the Roosted app directly.
## To enable calendar syncing:
* Go to Configuration - Settings - Worker Interaction - Calendar Sync.
* Enable the items as needed
Once enabled, users can set up calendar synchronization individually. To do this, click on the Profile icon in the upper right corner and select the Calendar Sync tab. You can choose to sync either the Worker Calendar, the Admin Calendar, or both. The information synced to the workers' calendar includes:
* **Event Name**
* **Shift Start & End Time**
* **Venue** (including any venue comments)
* **Event Comments**
* **Shift Comments**
## Whatβs the difference between the Worker Calendar and the Admin Calendar?
* **Worker Calendar**: This calendar displays only the shifts assigned to you. It allows workers to sync their specific shifts to their personal calendar, providing a focused view of their scheduled work.
* **Admin Calendar**: This calendar syncs all company events to an adminβs personal calendar. It provides a comprehensive overview of all events, including shifts for all workers.
**Information synced to the Admin Calendar includes**:
* **Event Name**
* **List of Workers** (with shift start and end times)
* **Venue** (including venue comments)
* **Event Comments**
* **Shift Comments**
Check out our YouTube tutorials on how to synch your calendars!
# Communication
Source: https://docs.roostedhr.com/guides/communication/communication
Discover multiple ways that you or the system can communicate with your workers.
## When first creating / importing workers
When you **create a new worker**, they will get an email letting them know they've been added to your account, along with a password to use for logging in. If you are **importing workers**, you will need to onboard them by sending an email or text message with information on how to log in for the first time and instructions on using the system. See **[Onboarding](https://support.roostedhr.com/en/articles/9491914-onboarding-workers)** for more information.
## Worker / Shift & Admins Comments
When you create an event, there are several different ways you can add comments for workers or admins. On the **Main Event Page**, you can add event comments for workers by clicking **ADD EVENT COMMENTS FOR WORKERS** which opens a comment box. Here you can type information into this box or use a **[Comment Template](https://support.roostedhr.com/en/articles/9491130-comment-templates)**. This comment will be only available for the workers at the event.
You can do the same for specific skillsets in the Shift Comments. Below each skillset (shift) you can see a comment box where you can add information or a Comment Template.
After adding a comment manually, always click on *UPDATE EVENTS COMMENTS FOR WORKERS or UPDATE SHIFT COMMENTS* to save it. You can also add comments for admins only - click *ADD EVENT COMMENTS FOR ADMINS* and remember to save the comment *UPDATE EVENT COMMENTS FOR ADMINS* when you're ready! These comments are visible ONLY to the admins!
## Announcements & Chats
Announcements & Chats are a way of communicating with your workers. Please see **[Announcements & Chats](https://support.roostedhr.com/en/articles/9497299-announcement-chats)** for more information
## Sign-Up Bot
Our favorite robot is called Sign Up Bot. It will automatically reach out to your workers to fill empty shifts through push notifications or text messages. Please see **[Sign-Up Bot](https://support.roostedhr.com/en/articles/9497214-sign-up-bot)** for more information.
## Shift Check-In Bot
Shift Check-In Bot is designed to reduce no-shows and late arrivals by asking your workers to check in online before their shifts, just like for a flight. Roosted can email and text your workers in advance and ask them to Check-In. Please see **[Shift Check-In](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot)** for more information.
## Text Message (Push Notifications)
There are several Push Notifications/Text Messages options that you enable or disable on your account - you can control what is sent to your workers. Please see **Text Message Notifications** for more information.
## Documents
Documents are an important way you can communicate with your workers. You can upload documents to events, a worker profile, upload company documents, and more. Please see **[Document Uploading](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot)** for more information! Please check our **[Youtube playlist](https://www.youtube.com/watch?v=x-dkZNjZHAg\&list=PLfWjGdpLI6-5VgTs3UDRJ4ON7s87-hHMg)** where you can find multiple useful tips on all topics explained in this article! And this is multiple ways that you can communicate with your workers using Roosted! π
# Event Chats
Source: https://docs.roostedhr.com/guides/communication/event-chats
Event Chats are an easy way of forwarding information to your workers scheduled for an event.
Let's dive into the worker's communication through event chats! Event Chats are an easy way of forwarding information to your workers scheduled for an event. You can quickly and easily send last-minute details to several or all workers.
## Creating an event chat
On the **Main Event Page**, you can create an event chat by clicking CREATE CHAT.
The chat box on the right-hand side will appear, showing all the workers scheduled for this event, including the person creating the chat. You can select or deselect people that you wish to chat with.
In the Next Step, you can name the chat - by default, it is the name of the Event.
The "Automatically add workers that join this event" option adds newly added workers and removes the ones who bailed out or were removed. Click the Create Chat button and all set - you just created an event chat and you can send messages to your workers! The messages are sent along with a timestamp and the notifications can be turned off/on by clicking the bell icon.
The wrench icon will allow you to edit the chat name and members.
To delete the chat, click the trash can on the top right-hand side. This is how you can use Event Chats to communicate information to your workers on specific events at Roosted! π
# Push Notifications
Source: https://docs.roostedhr.com/guides/communication/push-notifications
Enable push notifications from out app!
Push notifications are messages sent to your device through the mobile app. This system replaces text messages for many systems such as Sign Up Bot, event updates, punch notifications, and more.
# What is the benefit?
The main benefit is that the messages integrate into the mobile app. Tapping on the notification takes you directly into the app in the related section. This allows workers to quickly take action.
# Shift Update Notification
Source: https://docs.roostedhr.com/guides/communication/shift-update-notification
Control when and how your workers are notified about updates to shifts for which theyβre scheduled.
Whenever a change is made to a shift or an event these notifications are letting the worker know the newest updates.
## To whom are they sent?
Emails/text messages or push notifications can be sent to everyone who is assigned to the shift/event. A summary email will be sent to the reviewer. Only the workers who have been affected by the change will receive an update notification. This means, that if a shift had a time change, only that shift workers will be contacted - not the whole event.
## When are they sent?
Shift update notifications will be sent 15 minutes after the last edit. This way you can make a large number of changes and not worry about flooding your workers with notifications. That basically means that the system will automatically send one notification, exactly after 15 minutes after doing the last modification.
## How are they sent?
The notifications are sent out by email, push notification and/or text messages if push notifications are not available. When sent by a text message, **shift, event or location comments won't be included**. You can even restrict text messages to only be sent within several days of an event - in other words, you can set that the text message notifications will be sent **only if the shift occurs in a certain period of time.** You can easily change your Shift Update Notification settings in **Shift Update Notifications - Settings.**
# Availability & Time Off - Settings
Source: https://docs.roostedhr.com/guides/configuration/availability-time-off-settings
How to manage your workers time off and availability?
You can enable or disable the ability for workers to submit Availability & Time Off requests. For details on where workers can submit these requests, refer to the **[Availability & Time Off](https://support.roostedhr.com/en/articles/9491872-availability-time-off)** section. To adjust your Availability settings, follow these steps:
1. Navigate to **Configuration**.
2. Go to **Settings**.
3. Select **Worker Interaction**.
4. Click on **Availability**.
Here, you can manage and update the settings related to worker availability and time off. In this area, you have three options to configure your Availability settings:
## Availability System Active
### Enable
Turns on the availability system, allowing workers to submit their availability. You can also view who has matching availability when scheduling. You can override this if needed, by scheduling workers who do not match the availability.
### Disable
Workers cannot submit their availability, and the availability calendar will be removed from their home screen.
## Restrict Sign-Ups and Requests Based on Availability
### Enable
Enforces the availability system. Workers will only be able to see and sign up for or request shifts that match their availability. Workers who have not input any availability will also be restricted.
### Disable
Puts the availability system into non-enforcing mode. Workers can still use the availability calendar but are allowed to see and sign up for or request shifts that do not match their availability.
## Stop Sign-Up Bot from Contacting Workers Without Matching Availability
### Enable
Sign-Up Bot will not contact workers who do not have matching availability in their calendar or who have not input any availability at all. 9.
### Disable
Sign-Up Bot will continue to contact workers regardless of whether their availability matches or if they have not used the availability calendar.
These settings help you manage how availability is used and enforced within your scheduling system.
## Troubleshooting Availability Issues
If you or your workers are unable to see shifts, follow these troubleshooting steps to ensure the availability system is functioning correctly:
### Test the System
1. **Enable the Availability System**.
2. **Create Sample Shifts**.
3. **Enter Sample Dates** in the availability calendar.
4. **Check Visibility**: Verify if the sample shifts are visible based on the entered availability.
### Common Issues and Solutions
#### Assumed Shift Length
If using the Multiple Shifts Per Day option, check the assumed shift length. If end times are not specified, the system assumes a shift length based on this setting. Adjust the assumed shift length if shifts are too long for workers to be considered available.
#### Incorrect Dates and Times in the Availability Calendar
Ensure workers have input availability for the entire duration of each shift. Availability must cover 100% of the shift length to be considered.
#### Check Shift Start and End Times
Verify that shift start and end times match the workerβs availability. Common issues include shifts starting too early or ending too late.
#### Verify Skillsets
Ensure the worker has the required skillsets for the shift.
#### Time Off Requests
Check if the worker has any pending or approved time off requests.
#### Conflicting Shifts
Confirm that the worker is not scheduled for another shift that overlaps, even partially.
#### Multiple Shifts Per Day
If the worker is already on a shift during the day, they may not be available for additional shifts unless the Multiple Shifts per Day option is enabled.
## Additional Notes
### System Recommendations
Itβs generally not recommended to use the availability system unless it meets specific needs. If a worker hasnβt submitted availability, the system assumes they are available.
### Time Off Settings
Adjust Time Off settings by navigating to **Configuration** β **Settings** β **Worker Interaction** β **Time Off Requests**.
If **Time Off Requests** is turned on, workers can submit time off requests through their Worker Calendar. If turned off, workers will need to contact HR to submit requests.
By following these steps, you can diagnose and address issues with the availability system to ensure proper functionality. Please see **[Time Off Manager](https://support.roostedhr.com/en/articles/9497286-time-off-manager)** for more information on approving, and denying requests.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π»
# Bailout Settings
Source: https://docs.roostedhr.com/guides/configuration/bailout-settings
How to adjust your Bailout settings through Roosted.
In this article, we will explain how to adjust your Bailout settings. A bailout is a worker removing a shift from their schedule. See **[Bailouts](https://support.roostedhr.com/en/articles/9497156-bailouts)** for more information.
You can customize various settings for bailouts, including specific time frames for when workers can bail out and custom warning messages. To access these settings, go to **Configuration** in the admin bar, then **Settings - Worker Interaction**. Click to expand the options, and youβll find **Bailouts** at the top.
## Active
**If toggled on:** workers can bail out of shifts within a specified time frame based on your settings.
**If toggled off:** workers will be blocked from bailing out and prompted to contact HR instead. In this case, admins will need to manually bail out workers from shifts.
## Customize When a Worker Can Bailout
**If toggled on:** you can further customize the settings:
* Admins can receive an email if a worker bails out within a certain number of days before the event.
* You can lock bailouts within a specified number of days before an event.
**If toggled off:** the two sliders will be greyed out.
The default settings will then apply: **admins will not receive emails, and bailouts will be locked one day before the event.**
## If Bailouts are Forbidden, Automatically Append Company Email to Message to Worker
**If toggled on:** workers will receive a message to contact HR.
## Email Admins If a Worker Bails Out in Less Than This Amount of Days
Customize the number of days before an event so that if a worker bails out admins will receive an email. If set to 7 days, admins will receive an email if a worker bails out within 7 days of the event.
You can also lock bailouts within a specific number of days before the event - if set to 3 days, workers will be unable to bail out themselves starting 3 days before the event. They will be instructed to contact HR for assistance.
## Customize Warning Message
In this section, you can edit the message that will appear to your workers when they are attempting to bailout of a shift.
If you edit this message, it will appear as shown below.
And that is how you can adjust your Bailout Settings in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€
# Client Signature - Settings
Source: https://docs.roostedhr.com/guides/configuration/client-signature-settings
Adjust your Client Signature to receive signing approval on an event from either a physical client or a senior staff member.
In this article, we will guide you through adjusting your Client Signature Settings in Roosted. This feature allows you to receive signing approval on an event from either a physical client or a senior staff member.
To adjust your settings, navigate to **Configuration** -> **Settings** -> **Time Tracking** -> **Client Signature**.
From this page, you can modify the following settings.
## Toggle Client Signature On/Off
**If toggled on**, you can adjust additional settings.
**If toggled off**, all following settings will be greyed out.
## Email Clients on Signature
**If enabled**, an email will be sent to the main email address listed in the clientβs profile.
**If disabled**, no email will be sent.
If you are seeking a signature from a senior staff member and do not need to
notify the client, ensure this is toggled off. For further assistance, contact
your Client Support Specialist.
## Email Reviewer on Signature
**If enabled**, the assigned Event Reviewer will receive an email confirmation when a signature is received.
**If disabled**, they will not receive an email.
## Email Time Tracking Manager on Signature
**If enabled**, the assigned Event Time Tracking Manager will receive an email confirmation of the signature.
**If disabled**, they will not.
## Email All Admins on Signature
**If enabled**, all admins on the account will receive an email when a signature is received.
**If disabled**, they will not.
## Email All Owners on Signature
**If enabled**, all owners will receive an email notification of the signature.
**If disabled**, they will not.
## Include Individual Punches on Signature Email
**If enabled**, the email will include a list of individual time punches for the event. This applies to all email notifications set above.
**If disabled**, individual punches will not be included.
And thatβs how you can adjust your Client Signature settings in Roosted! π
# Comment Templates
Source: https://docs.roostedhr.com/guides/configuration/comment-templates
Comment templates are pre-saved sets of information that you can add to any event to be viewed by your workers. They can contain information about the uniforms, parking, entrance codes, or anything you could need to pass to everyone before the event! How convenient, right? It is easy to add, edit, and delete templates from the **Configuration -> Comment Templates** section in the Admin tab. You will see there all your saved templates and be able to update or delete them as needed!
## Adding and Editing a Comment Template
To add a template just click the + icon in the top right. To edit, choose the blue wrench. You can name it, and format the message you wish to add. When you are ready, just click ADD COMMENT TEMPLATE. If you just made an edit, the button SAVE COMMENT TEMPLATE will show.
## Deleting a comment template
To delete a template, just click the red X button - a pop up window will show. To confirm, choose DELETE COMMENT TEMPLATE.
## Where Can I Use Comment Templates?
Comment templates can be added to an event or a specific shift in it. To add templates for an event, that will be visible to all workers, go to the main event page, and choose the comment template you wish to add from the dropdown menu. Like that, you will add the template to the event comments **for all workers.**
We can also add them only to a designated group of people assigned to this event. Choose a specific shift, and add comments that will be visible only for just those workers. Like that, only these 2 workers will see that comment.
And that's how you use comment templates in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Communication Center
Source: https://docs.roostedhr.com/guides/configuration/communication-center
Workers communication - how to gain the most of it?
In this article, we will explain the Communication Center in Roosted and the information it can provide. The Communication Center can be found by navigating to Configuration -> Communication Center.
## Unknown Messages Received
If a worker replies to a NO REPLY text message or sends a message not directly related to a system message, it will appear here. This section provides the worker's name, the time the message was sent, the message content, and the last message the system sent to the worker.
## Sent Group Messages
Here you can see a list of announcements that your workers have received along with the details of the sending time, which admin sent it, the type of message, the subject title, and the message itself.
Check out our latest video that expands the topic to the fullest:
And this is your Communication Center on Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) β
# Company Information
Source: https://docs.roostedhr.com/guides/configuration/company-information
What data should you enter about your company and how?
You can view and change your company name, email address, and more in Configuration - Company Info.
From here you can easily update your Company Name, Company Number, Email (*very important for billing*) & Address.
Please ensure that your Timezone is correct as this is very important for
billing purposes. You can also update your HR information. This is the
information that your workers will see when they go to the help section if
they try to bailout or if their account has been inactivated.
You can update your payment information by clicking Edit Card. If you see the yellow ! exclamation mark sign means that there is an issue with a card on file and it needs to be updated.
You will also be able to see your billing for the current period as well as previous billing periods by selecting the dropdown.
Please check our youtube training that covers the topic insideout!
And this is the company information page on Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Configuration Module
Source: https://docs.roostedhr.com/guides/configuration/configuration-module
All the possibilities that Roosted offers to you.
In this article, we will go through The Configuration Module. It is a crucial part of your Roosted account, a base of how you use this powerful tool. Configuration can be found on the blue bar on the left side.
Configuration is broken up into the following categories:
* Settings
* Venues
* Skillsets
* Comment Templates
* Blogs
* Documents
* Custom Fields
* Payroll Groups
* Credentialing
* Wage Types
* Integrations
* Communication Center
* Company Info
## Settings
Please pay particular attention to the settings page, as this is vital for
customizing your Roosted account to work for you!
On the settings page, you can adjust various options to tailor your Roosted experience to your preferences. This ensures your account is configured to meet your specific needs and workflow. See **[Settings](https://support.roostedhr.com/en/articles/9491107-configuration-settings)** for more information.
## Venues
Venues are the locations where your events take place. Each venue includes details such as the name, address, timezone, and any additional comments you may want to include. To view and manage your venues, go to **Configuration - Venues**. Please see **[Venues](https://support.roostedhr.com/en/articles/9491115-venues)** for more information.
## Skillsets
Skillsets are positions or roles that you can fill on an event. If we need 5 Servers and 2 Bartenders. Server & Bartender would be considered skillsets. See **[Skillsets](https://support.roostedhr.com/en/articles/9491123-skillsets)** for more information.
## Comment Templates
Comment templates are pre-saved sets of information that you can add to any event to be viewed by your workers. they can contain information about the uniforms, parking, entrance codes, or anything you could need to pass to everyone before the event! See **[Comment Templates](https://support.roostedhr.com/en/articles/9491130-comment-templates)** for more information.
## Blogs
Roosted includes a corporate blog that can be used as a newsletter or a way of communication with your workers. The blog gives admins the ability to post, edit, and delete posts to the blog. See **[Blogs](https://support.roostedhr.com/en/articles/9484617-blogs-desktop-mobile-app)** for more information.
## Documents
Your employer uploads company documents, which may include the handbook or payroll information. They can be viewed and downloaded from your account & Mobile App. See **[Documents](https://support.roostedhr.com/en/articles/9484845-company-documents-desktop-mobile-app)** for more information.
## Custom Fields
Custom fields are used to track additional information - they can be understood as a requirement that you may have for your Workers, Events, or Clients. See **[Custom Fields](https://support.roostedhr.com/en/articles/9491142-custom-fields)** for more information.
## Payroll Groups
Payroll groups are used to assign wage groups, advanced payroll rules, and invoice costs and IDs. See **[Payroll Groups](https://support.roostedhr.com/en/articles/9497345-payroll-groups)** for more information.
## Credentialing
The Credentialing system is where we can upload and store credential information for workers. Credentials can be things such as background checks, DMB certifications, and even nursing licenses. This is particularly useful for Healthcare and many of our customers who have specific requirements for their workers.
## Wage Types
Wage types are how Roosted decides what wage a worker should receive for a shift. See **[Wage Types](https://support.roostedhr.com/en/articles/9497348-wage-types)** for more information.
## Integrations
Integrations are used to connect your ATS (*Applicant Tracking System*) to work alongside your Roosted account and easily manage applicants to your job postings. See **[Integration](https://support.roostedhr.com/en/articles/9491216-integrations)** for more information.
## Communication Center
Your communication center can be used to keep track of communications that have been sent to your workers. See the [**Communication Center**](https://support.roostedhr.com/en/articles/9491266-communication-center) for more information.
## Company Info
You can view and change your company name, company email address, and much more! See **[Company Info](https://support.roostedhr.com/en/articles/9491294-company-information)** for more information.
And this is your Configuration Module on Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π₯³
# Configuration Settings
Source: https://docs.roostedhr.com/guides/configuration/configuration-settings
How to set up your account so it meets all your needs? All the possibilities explained.
In this article, we'll guide you through adjusting your Roosted settings to tailor your experience perfectly!
## Accessing Your Settings
To find your settings page, navigate to **Configuration** and then select **Settings**. The settings page is organized into four main sections:
1. **Shift Options**
2. **Worker Interaction**
3. **Worker Communication**
4. **Admin & Time Tracking**
Each section offers various options to customize and enhance your Roosted experience. Let's dive in and explore these settings to make the most out of your platform!
## Shift Options
### Shift Requests
Shift Requests is the process of allowing your workers to request to work on shifts that are available with their skillsets.
See [Shift Requests](https://support.roostedhr.com/en/articles/9497202-shift-request) for more settings information.
### Multiple Shifts per Day
Multiple shifts per day does exactly what it sounds like. This allows workers to pick up multiple shifts in a day as long as they do not conflict with each other time-wise.
See [Multiple Shifts per Day](https://support.roostedhr.com/en/articles/9491344-multiple-shifts-per-day) for more settings information.
### Shift Equalizer
Shift Equalizer is the process of evenly balancing your workers, with the highest and lowest ratings across 2 events on the same day.
See [Shift Equalizer](https://support.roostedhr.com/en/articles/9491383-shift-equalizer) for more settings information.
### Shift Visibility
With Roosted, workers earn privileges and perks by showing up on time, doing their job well, and staying committed to your company. One of these privileges is the length of time into the future that a worker can see, and sign up for or request, available shifts.
See [Shift Visibility](https://support.roostedhr.com/en/articles/9681696-shift-visibility) for more settings information.
### Shift Limits
This allows you to set limits on workers signing up for shifts based on the number of shifts and number of hours each week.
See [Shift Limits](https://support.roostedhr.com/en/articles/9497168-shift-limits) for more settings information.
## Worker Interaction
### Bailouts
A bailout is a worker removing a shift from their schedule.
See [Bailout Settings](https://support.roostedhr.com/en/articles/9491447-bailout-settings) for more information.
### Availability & Time Off Requests
Availability is a way for workers to let you know that they are available to work. Time Off Requests can be submitted for admin approval (*depending on the company settings*).
See [Availability & Time Off - Settings](https://support.roostedhr.com/en/articles/9491463-availability-time-off-settings) for more information.
### Reviews and Stars Visibility
Each worker will have a star rating which will appear on their profile and a star rating reviews that have been added after a shift the worker has completed.
See [Reviews and Stars Visibility](https://support.roostedhr.com/en/articles/9491480-reviews-and-stars-visibility) for more settings information.
### Blogs
Blogs are used to relay information or as a company newsletter. Blogs can be turned on or off.
See [Blogs](https://support.roostedhr.com/en/articles/9484617-blogs-desktop-mobile-app) for more information on using blogs.
### Coworker Display
You can display information to workers about their coworkers on each shift and/or event.
See [Coworker Display](https://support.roostedhr.com/en/articles/9491503-coworker-display) for more information.
### Calendar Sync
You can allow workers and admins to sync their Roosted calendar to their Gmail or Apple calendars.
See [Calendar Sync](https://support.roostedhr.com/en/articles/9497309-calendar-sync) for more information.
## Worker Communication
### Sign-Up Bot
Sign-Up Bot is the best to help schedule your workers for open shifts and can be used automatically or semi-automatically (*giving you more control*).
See [Sign-Up Bot](https://support.roostedhr.com/en/articles/9497214-sign-up-bot) for more information.
### Shift Check-In Bot
Shift Check-In Bot is used as a reminder system for your workers, informing them they have a shift coming up. This can also give you peace of mind that the worker will be there.
See [Shift Check-In Bot](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot) for more information.
### Silence / Testing Mode
Silence / Testing Mode allows you to test out creating schedules without contacting any of your workers.
See [Silence / Testing Mode](https://support.roostedhr.com/en/articles/9491650-silence-testing-mode) for more information.
### Text Message Notifications
You can adjust how and what type of text messages you would like to send to your workers.
See [Text Message Notifications - Options](https://support.roostedhr.com/en/articles/9491681-text-message-notification-options) for more information.
### Custom Account Messages
Custom Account Messages are tailored error messages that appear when a worker attempts to log in, but their account is either inactive or pending approval. These messages provide clear information to the worker and include your company's HR contact details, which are entered on your Company Info page.
See [Custom Account Messages](https://support.roostedhr.com/en/articles/9491707-custom-account-messages) for more information.
### Invite to Work
Invite to Work is essentially a self-exploding offer. The main use is to invite workers to work a shift when you are unsure if they are able to work the shift.
See [Invite to Work - Settings](https://support.roostedhr.com/en/articles/9491776-invite-to-work-settings) for more settings information.
### Shift Update Notification
Shift Update Notifications are used to communicate any changes you have made to shifts that they are working.
See [Shift Update Notification](https://support.roostedhr.com/en/articles/9497306-shift-update-notification) for more information.
## Admin
### Daily Summary
The Daily Summary provides admins with information on all upcoming shifts. You can enable or disable this feature and choose to receive it daily or weekly. It includes various details about events, and you can also choose to hide worker phone numbers, email addresses, shift comments, and skillset comments.
### Calendar View Options
Calendar View Options allows you to customize how you would like Calendar View to appear when using it.
See [Calendar View Options](https://support.roostedhr.com/en/articles/9496995-calendar-view) for more information.
### Worker Profile Locks
You have the ability to lock workers from updating information on their profiles.
See [Worker Profile](https://support.roostedhr.com/en/articles/9491851-editing-a-worker-profile) for more information.
### Shift Publishing
The Shift Publishing feature allows you to work on and edit shifts while they are in an unpublished status. You can finalize and publish them with a single click when you're ready. This is especially useful if you need to adjust start times, locations, or other details before making them public.
See [Shift Publishing](https://support.roostedhr.com/en/articles/9497043-shift-publishing) for more information.
### Removal/Bailout Reasons
Here, you can adjust if, in case of a bailout or removal of a worker from a shift, there must be a provided reason. They can be such as "Changed mind", "Family issues", "Had to cover a different event" or anything that may happen to your workers.
See [Bailouts](https://support.roostedhr.com/en/articles/9497156-bailouts) for more information.
## Time Tracking
In Roosted's Time Tracking settings, you can customize various aspects to streamline and manage time punches effectively. Here's a breakdown of the available options:
### Allow workers to punch in for events
* **Enabled**: Workers can punch in for their shifts independently.
* **Disabled**: Only Reviewers, Event Time Tracking Managers, or admins can punch workers in.
### Pre-Approve All Time Punches
This setting allows time punches to be automatically approved if they meet the predefined criteria. This reduces the need for manual approval by an admin.
### Allow Workers to Sign Off on Time Punches
Workers can sign off on their time punches at the end of their shift, helping to minimize disputes related to hours worked.
### Custom Legal Acknowledgement
This feature enables workers to indicate their agreement or acknowledgment when punching out of a shift.
See the [Custom Legal Acknowledgement](https://support.roostedhr.com/en/articles/9491777-custom-legal-acknowledgement) section.
### Reviewer Punches
You can grant Reviewers the ability to punch workers in and out of their shifts.
### Selfie Verification
Request a selfie from workers at the time of their punch, and make it a requirement if desired. This ensures the identity of the worker when clocking in or out.
### Location Tracking and Geo-Fencing
Collect location data from workers at the time of their punch. You can also enable **Geo-Fencing** to restrict the distance a worker can punch in or out from the event location.
See the [Geo-Fencing](https://support.roostedhr.com/en/articles/9491778-geo-fencing) section.
### Require Location with Anytime Punches
For information on requiring location data with Anytime Punches, see the [Anytime Punches](https://support.roostedhr.com/en/articles/9491858-anytime-punches) section.
### Early and Late Punches
Enable settings to limit how early workers can punch in before their shift starts and how late they can punch out after their shift ends. Adjust the sliders to set these limits.
### Payroll Period Settings
* **Fiscal Start of Week**: Choose the day your payroll period begins.
* **Maximum Normal Shift Time**: Set the maximum shift length. Shifts longer than this will be flagged in the Time Tracking Module. For example, if set to 8 hours, a shift clocked at 8 hours and 1 minute will be flagged for approval.
### Time Format
Toggle between AM/PM and 24-hour clock formats for the Time Tracking Module.
### Overtime and Doubletime Settings
Use sliders to set parameters for Daily Overtime, Daily Doubletime, Weekly Overtime, and Weekly Doubletime. These settings will be applied in the Time Tracking Module when tracking worker hours.
### Payroll Period Options
Select the frequency of your payroll period: Weekly, Every 2 Weeks, Twice a Month, or Monthly.
### Worker Hours Display
Allows a worker to see their time tracking hours and their future expected hours on their Roosted Mobile App.
See [Worker Hours Display](https://support.roostedhr.com/en/articles/9491786-worker-hours-display) for more information.
### Reimbursements
A way of paying your workers for expenses or mileage that they have incurred as part of working a shift.
See [Reimbursements](https://support.roostedhr.com/en/articles/9497271-reimbursements) for more information.
### Client Signature
The Event Time Tracking Manager, Admins & Owners can receive a signature from the client at the end of the shift.
See [Client Signature](https://support.roostedhr.com/en/articles/9497341-client-signature) for more information.
***
And this is your Settings page in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com).
# Coworker Display
Source: https://docs.roostedhr.com/guides/configuration/coworker-display
Understanding Coworker Display in Roosted
In this article, we will explain how the **Coworker Display** feature works and how you can customize it to suit your needs.
## What is Coworker Display?
**Coworker Display** allows you to show information about coworkers for each shift and/or event. This feature helps employees see who they will be working with, fostering better communication and coordination.
## Customizing Coworker Display
You can choose which information is displayed or hidden. To adjust these settings:
1. Navigate to **Configuration**.
2. Select **Settings**.
3. Go to **Worker Interaction**.
4. Click on **Coworker Display**.
Here, you can customize which details about coworkers are visible during each shift or event. This ensures that employees have access to relevant information while maintaining privacy where necessary.
### Display Coworker Information from the Same Shift
When you enable this setting, workers will be able to see the names of their coworkers scheduled for the same shift. However, they will not have access to information about coworkers on other shifts within the same event.
If you toggle this off, all the following settings will be greyed out.
### Display Coworker Information for the Entire Event
By toggling this on, workers will be able to view the names of all their coworkers for the entire event, not just those on their current shift.
## 3 more pieces of information can be mix and matched
### Display coworkersβ phone numbers (in addition to their names)
By toggling this on, coworkers will be able to see their coworker's phone number in addition to their name.
### Display coworkersβ email addresses (in addition to their names)
By toggling this on, workers will also be able to see their coworker's email addresses.
### Display coworkersβ shift titles (in addition to their names)
By toggling this on, workers will be able to see their coworkers' shift titles (i.e Bartender / Server etc.)
And that is how you can use Coworker Display in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Custom Account Messages
Source: https://docs.roostedhr.com/guides/configuration/custom-account-messages
Message your worker will receive to inform them about disabling their account.
Custom Account Messages are essentially an error message that will appear along with your company HR information (that has been entered on your Company Info page) if a worker tries to log in and their account has either been.
You can customize the error messages and ensure they include relevant HR contact information to assist workers with account-related issues.
## Account Related Issues
### Made inactive
If a worker has been made inactive and attempts to log in, the Custom Account Message will appear.
### Has not been approved
If a worker has signed up to be a worker through [Worker Self Sign-Up](../workers/worker-self-sign-up), their profile has yet to be approved and they attempt to log in the Custom Account message will appear.
## How Do They Appear?
When a worker attempts to log in using the Desktop or Mobile Browser, they will see a message that you set up before:
## Customizing Message
You can personalize the error messages that appear when a worker attempts to log in while their account is inactive or pending approval. These messages, which also include your company's HR contact information, can be tailored to fit your company's needs. To customize your account messages:
1. Navigate to **Configuration**.
2. Select **Settings**.
3. Go to **Worker Communication**.
4. Click on **Custom Account Messages**.
Click on the current message and type in your desired text.
And this is how you use your Custom Account Message in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π₯
# Custom Fields
Source: https://docs.roostedhr.com/guides/configuration/custom-fields
Personalise your needs and information about workers, events or clients with Custom Fields by your choice.
## What are the Custom Fields?
Custom fields are used to track additional information - they can be understood as a requirement that you may have for your Workers, Events, or Clients. They can be added, edited & deleted in Configuration - Settings - Custom Fields.
## Workers
There are multiple uses for Custom Fields for Workers - you can request certificates, tests, or licenses. Only workers with those added to their profiles will be able to work particular event.
### Worker Editable
allows a worker to make a change - for example, whether they have covid test or not. Please see [Worker Profile - Desktop](../workers/worker-profile-desktop) & [Worker Profile - Mobile App](../workers/worker-profile-mobile-app) for more information.
### Useable for Rules
Indicates if the custom field will be possible to use while creating a rule, which is another way of filtering worker's requirements. Please see **[Rules](https://support.roostedhr.com/en/articles/9497157-rules)** for more information
### Creating a Worker Custom Field
Various types of custom fields can be added to a worker.
* **Single Line Text (Basic Input)** - typically Employment ID's, Payroll Numbers, hourly wage
* **Multiple Line Text (Paragraph)** - explanation or description from or about the worker.
* **Date** - license expiration dates such as TIPS bartending expirations, Medical licenses etc. This custom field is particularly powerful it can automatically send an email to HR & the employee, 30 days before expiration or at the date itself.
* **Dropdown** - uniform sizes, yes & no answers (i.e can drive carpool) & more.
* **File** -licenses or certificates. If it is Worker Editable, your worker can upload the documents directly for specific custom fields created.
## Events & Clients
Here we can create Single Line Text (*Basic Input*) or Multi Line Text (*Paragraph Style*). It can be used to keep track of additional information on an event or client. Event & Client Custom Fields can be viewable to workers or not.
## Adding a Custom Field
To add a field click ADD FIELD -> Select which type of Custom Field you want to add from the dropdown and customize to your requirements.
## Editing a custom field
To edit a custom field click the wrench on the right side.
You can rename the field, add a description, toggle on or off whether this custom field is Worker Editable, etc. You can adjust the content as per your needs. Once you have finished your edits you can click SAVE.
## Deleting a custom field
Click the wrench on the right side and choose delete twice - if it is used for shift rules, the rule will also be deleted. Please check out our YouTube trainers to see a more detailed overview!
And that is how you use Custom Fields in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€
# Custom Legal Acknowledgement
Source: https://docs.roostedhr.com/guides/configuration/custom-legal-acknowledgement
The feature allows you to require workers to provide their agreement or acknowledgment when they punch out of a shift.
You can now require your workers to indicate their agreement or acknowledgment when punching out of a shift. This feature is often used for legal purposes, such as collecting signatures for disclaimers or waivers (like a meal break waiver).
To customize the Custom Legal Acknowledgment, follow these steps:
1. Navigate to the settings page by selecting the **Blue Admin Bar** on the left-hand side.
2. Go to **Configuration**.
3. Click on **Settings**.
4. Select **Time Tracking**.
5. Click on **Custom Legal Acknowledgment**.
Here, you can enable or disable this feature and tailor the acknowledgment message to meet your specific needs.
Check our Roosted YoutTube channel for more info on this, and more topics:
# Geo-fencing
Source: https://docs.roostedhr.com/guides/configuration/geo-fencing
Geo-Fencing in Time Tracking
**Geo-Fencing** uses the GPS signal from a worker's phone to determine their location, helping to ensure that they are at the correct venue when punching in or out. You can configure Geo-Fencing as either a Hard Geo-Fence or a Soft Geo-Fence.
* **Hard Geo-Fence**: Workers are restricted from punching in or out unless they are within the set geo-fence boundary. If they are outside this boundary, they cannot punch in or out.
* **Soft Geo-Fence**: Workers can punch in or out even if they are outside the geo-fence boundary, but these punches will appear as pending and require approval from an admin with Time Tracking capabilities.
For a Hard Geo-Fence, please contact your Client Support Specialist or open a
support ticket.
## Enabling Geo-Fencing
To enable Geo-Fencing:
1. Navigate to **Configuration**.
2. Select **Settings**.
3. Go to **Time Tracking**.
4. Under **Get Location**, toggle Geo-Fencing on.
You can then set the distance limit for the geo-fence. For example, if set to 500 feet, workers will only be able to punch in or out if they are within 500 feet of the event's listed address.
### Notes on Accuracy
Some older or entry-level phones may have trouble with location accuracy. We recommend setting a geo-fence of at least 1000 feet to accommodate these devices.
## Selective Geo-Fencing
For venues where the listed address is far from the actual event location, you may wish to disable geo-fencing for those specific events.
To disable geo-fencing for an individual event:
1. Go to the **Main Event Page** for the event.
2. Click on **Options**.
3. Deselect **Geofencing Enabled**.
This allows you to tailor geo-fencing settings to suit different venue requirements.
Check our YouTube tutorial which covers the topic inside out!
And that is how you can using Geo-Fencing through Roosted! π
# Integrations
Source: https://docs.roostedhr.com/guides/configuration/integrations
How do you integrate external ATS with Roosted?
There are a number of Applicant Tracking Systems (ATS) that you can integrate with Roosted to manage applications for your job postings.
## Adding an ATS Integration
To add an ATS integration, navigate to **Configuration - Integrations**. From this page, click **ADD - Applicant Tracking System.**
Once you click this, you can browse the list of ATS systems that Roosted can connect with. If you use an Applicant Tracking System that is not listed, please contact your Client Success Specialist or open a support ticket.
You can select your current ATS system by clicking its name. Some ATS applications will require you to log in using your User ID and Password, while others might ask for your subdomain or API key.
For applications that require your subdomain or API key, you can find instructions by clicking on 'How do I find my API key?' or 'How do I find my subdomain?'. Once your ATS is connected, it will appear on your integrations page as shown below.
Check our video expanding the topic to the fullest:
And this is how you can use Integrations to connect your ATS systems in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€ͺ
# Invite to Work - Settings
Source: https://docs.roostedhr.com/guides/configuration/invite-to-work-settings
Adjusting Your Invite to Work Settings
The **Invite to Work** feature allows you to offer shifts to workers even if you're unsure of their availability. This feature sends an invitation that the worker can either accept or decline. For detailed information on how the Invite to Work feature works, refer to the **[Invite to Work](https://support.roostedhr.com/en/articles/9497193-invite-to-work)** section. In this article, weβll walk you through how to adjust your Invite to Work settings.
To access these settings:
1. Navigate to **Configuration**.
2. Select **Settings**.
3. Go to **Worker Communication**.
4. Click on **Invite to Work**.
Hereβs what you can customize:
## Send Email for Invite to Work
**If enabled** workers will receive an email with the invite. The email includes a link for the worker to accept or decline the shift.
## Send Text Message for Invite to Work
**If enabled** workers will receive a text message with the invite if push notifications are not available or the app is not downloaded. The text message will include different codes for accepting or declining the shift.
## Push Notifications
When a push notification is sent with an invite to work, workers can tap the notification to be taken directly to the shift, where they can accept or decline it.
## Email Admins When Invite is Accepted
**If enabled** event admins will receive an email notification when a worker accepts an invite.
## Email Admins When Invite Expires or is Declined
**If enabled** event admins will receive an email notification when an invite either expires or is declined.
By configuring these settings, you can streamline the process of inviting workers to shifts and ensure that all relevant parties are informed of the worker's response.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) βοΈ
# Multiple Shifts Per Day
Source: https://docs.roostedhr.com/guides/configuration/multiple-shifts-per-day
Can my workers work many shifts per one day?
The feature of Multiple shifts per day allows all workers to be scheduled for multiple shifts per day. The shifts cannot cover each other - if that happens, the new shift won't be accepted. This feature can be managed from **Configuration** - **Settings** - **Shift Options - Multiple Shifts Per Day**
# Reimbursement - Settings
Source: https://docs.roostedhr.com/guides/configuration/reimbursement-settings
How to configure your reimbursement settings.
## Reimbursement Settings
In this article, we'll cover how to configure your reimbursement settings. To adjust these settings, navigate to: **Configuration** -> **Settings** -> **Time Tracking** -> **Reimbursements**. Hereβs what you can do:
## Activate Reimbursements
Toggle this button to enable or disable reimbursements. If turned off, reimbursements cannot be submitted by workers, admins, or owners, and all other settings on this page will be greyed out.
## Show Reimbursements to Workers
**If toggled on** workers can see reimbursements added for them on their Worker Calendar.
**If toggled off** workers will not see reimbursements, and this setting will be greyed out. Admins and owners can still add reimbursements to a worker's time punches.
## Allow Workers to Submit Reimbursements
Toggle this on to enable workers to submit reimbursements through the Worker Calendar. If off, workers will not be able to submit reimbursements, and the following settings will be greyed out.
## Require Workers to Submit a Picture with a Reimbursement Request
**If enabled**, workers must submit a picture with their reimbursement requests.
**If disabled**, submitting a picture is not required.
## Require Workers to Submit a Picture with a Mileage Request
Similarly, you can require workers to submit a picture with a mileage request. **If toggled off**, this is not required.
## Require Admins to Submit a Picture When Adding a Worker Reimbursement
**If enabled**, admins must submit a picture when adding a worker reimbursement.
**If disabled**, submitting a picture is not required.
## Require Admins to Submit a Picture When Adding a Worker Mileage Request
You can also require admins to submit a picture when adding a worker mileage request. **If toggled off**, this is not required.
And this is how you can configure your Reimbursement settings through Roosted! π
# Reviews and Stars Visibility
Source: https://docs.roostedhr.com/guides/configuration/reviews-and-stars-visibility
Control who sees the ratings of your workers.
There are several visibility settings for reviews and star ratings based on your preferences.
## Hiding Reviews from Workers
When enabled, written reviews left by the Event Reviewer or an admin will not be visible to the workers.
## Hiding Star Ratings from Workers
When enabled, workers will not see their star ratings. This includes both their overall rating and the ratings received for each shift.
## Hiding Star Ratings from Other Admins
When enabled, only the owner can view star ratings. However, admins with Configuration permissions can reverse this setting to see their own or others' star ratings.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π«Ά
# Shift Check In Bot - Settings
Source: https://docs.roostedhr.com/guides/configuration/shift-check-in-bot-settings
Set up the most convenient bot - it will manage your workers communication for you!
In this article, we will explain how to adjust your Shift Check In Bot settings to confirm attendance. This bot can be customized or disabled completely from Configuration - Settings - Worker Communication - Shift Check In Bot.
## Activate Shift Check In Bot
You can toggle **[Shift Check In Bot](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot)** on or off by using the Active toggle. If inactive, all further settings will be off.
## Customize Shift Check In Bot
When you toggle this on, you will be able to adjust the further settings. If inactive, all further settings will be off. If Customize Shift Check In Bot is off, **by default, the system will email workers 3 days before the start of an event and the admins 1 day before the event.** To enable text message notifications to workers, ensure Customize Shift Check In Bot is toggled on.
## Send Text Messages Along with Email
Decide if your workers and admins receive information via email only, or via notification / SMS too.
**If toggled off:** Shift Check In Bot will only be sent by email. You can customize the timing of these messages by adjusting the following sliders:
* **Email admins a summary of Shift Check Ins before each event**
Adjust how long before an event you would like admins to receive an email summary of how many workers have checked in or not checked in.
* **Workers are sent the Shift Check Ins asking them to check in**
Adjust how many days before the event you would like workers to receive the Shift Check In Bot message.
**The two sliders are additive.** For example, if the top slider is set to 1 day and the second slider is set to 2 days, workers will receive the message 3 days before the event and the email summary will go out 1 day before the event.
And that is how you can adjust your Shift Check In Bot Settings through Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€
# Shift Equalizer
Source: https://docs.roostedhr.com/guides/configuration/shift-equalizer
Roosted will balance your workers between shifts when you have multiple shifts on the same day.
Part of what makes Roosted so efficient is its ability to determine where workers are needed most. Roosted values your workers based on different criteria β just like a human scheduler would. If there is a single shift on one day, you want your best workers to fill that shift. However, **if there are multiple shifts on one day, your best staff may not be able to fill all the roles. Ideally, you want a mixture of your best workers and your lower-ranked staff.** If unbalanced, one shift may go perfectly, but another may have too many inexperienced workers. Roosted solves this issue by doing all those calculations for you.
Donβt worry anymore about balancing your shifts β Roosted has you covered.
## How It Works?
Navigate to **Configuration -> Settings -> Shift Options -> Shift Equalizer**. If Shift Equalizer is ON, Roosted will balance your workers between shifts when you have multiple shifts on the same day.
With this option ON, Workers can only see the one shift where they are needed most. They will not be able to see multiple shifts on the same day.
When the Shift Equalizer is OFF, workers can choose between different shifts on the same day, regardless of where Roosted thinks they are most needed.
And that's how Shift Equalizer works through Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Shift Publishing Settings
Source: https://docs.roostedhr.com/guides/configuration/shift-publishing-settings
Settings related to publishing your shifts.
In this article, we'll explain how to adjust your Shift Publishing Settings. **Shift Publishing** allows you to work on and edit shifts while they are unpublished. You can make adjustments to details before publishing them. For more information, check **[Shift Publishing](https://support.roostedhr.com/en/articles/9497043-shift-publishing)**.
To adjust your settings, navigate to **Configuration - Settings - Admin - Shift Publishing**. From this page, you can:
## Shifts Start Automatically as Published
* **On:** shifts will be automatically published, and visible to workers with the relevant skillsets, rules, or tags youβve set or are on your Preferred Workers list.
* **Off:** shifts won't be published automatically - you will need to press the "Publish" button on the event manually.
## Email Workers When a Shift Has Been Published
* **On:** Workers assigned will receive an email notification when shifts are published.
* **Off:** Workers will not receive email notifications for published shifts.
## If Push Notifications Are Not Available, Text Workers When a Shift is Published
* **On:** Workers will receive a text message if push notifications are not enabled or if they have not downloaded the mobile app.
* **Off:** Workers will not receive text messages or push notifications.
And thatβs how you can adjust your Shift Publishing Settings through Roosted! π
# Shift Update Notification - Settings
Source: https://docs.roostedhr.com/guides/configuration/shift-update-notification-settings
What is the best way to set up your shift notifications?
From the settings page, you can adjust how you would like to use Shift Update Notifications. Navigate to Configuration -> Settings -> Worker Communication -> Shift Update Notification.
On this page, you can toggle Active on or off to choose whether to use these notifications. If toggled on, you can adjust the following settings. If turned off, the settings will be greyed out.
## Settings
1. **If push notification is not available, send updates via text message (in addition to email)**
**If toggled on:** workers will receive text messages if push notifications are disabled, in addition to email updates.
2. **Limit updates to events that are occurring soon**
**If toggled on:** you can adjust the time frame using the sliding scale below this setting. For example, if set to 24 hours, workers will only receive text/push notifications about shifts starting within the next 24 hours.
**If toggled off:** workers will receive notifications for all future scheduled events.
3. **Only send updates via text message if the shift occurs within:**
Use the sliding scale to set the time frame for sending text notifications about event changes. This setting is available if the above setting **is toggled on**.
If you require the sliding scale to extend beyond the maximum, contact your Client Success Specialist or open a support ticket.
And this is how you can adjust your Shift Update Notification settings through Roosted! π
# Sign-Up Bot - Settings
Source: https://docs.roostedhr.com/guides/configuration/sign-up-bot-settings
In this article, we will go through the Sign-Up Bot Settings and how it can be used to fill up open shifts. See the **[Sign-Up Bot](https://support.roostedhr.com/en/articles/9497214-sign-up-bot)** article for more information.
To adjust your Sign-Up Bot settings, navigate to **Configuration - Settings - Worker Communication - Sign-Up Bot.** You can turn it on or off by a toggle - if it is active the following settings will display:
Sign Up Bot will only work on shifts that occur within this time frame
Set it to send notifications only for shifts happening in a particular timeframe by adjusting the scale to Fully Automatic or Semi-Automatic mode:
If you need a bigger scale, we have you covered! Contact your Client Success Specialist or open a support ticket.
## Blackout Times
These hours will be excluded from the bot's work - blackout **before** set at 8:00 AM & blackout **after** set at 8:00 PM means, that **notifications will only be sent between 8:00 AM & 8:00 PM.**
## Semi-Automatic / Fully Automatic
### Semi-Automatic
Notifications will be prepared to be sent but will have to be manually approved by Admins or Owners on each shift individually. Without confirming it by clicking the button, **the messages won't be sent.**
### Fully Automatic
With this setting on, notifications are sent automatically without any approval needed.
### Bailed-out workers
With this setting on, workers who have bailed out, declined an invite, or declined a Sign-Up Bot message for a shift won't be contacted.
And this is how you can adjust your Sign-Up Bot settings on Roosted!
# Silence / Testing Mode
Source: https://docs.roostedhr.com/guides/configuration/silence-testing-mode
Testing mode - how to use it and what is it's purpose?
The testing mode allows you to test out creating schedules or events without contacting any of your workers.
## How to Turn Silence/Testing Mode On or Off?
Test mode can be managed from Configuration - Settings - Worker Communication - Silent/Testing Mode. With the mode turned ON, the pink banner will show on the top of the screen.
## Think of It as a Demo
This mode sends all communication into a black hole - once you disable Silence Mode, the messages will not get sent out.
## It Will Still Contact Admins
Although Silence Mode won't send worker communication, it will still send messages to admins. Use it for testing purposes - see what Roosted can do.
Use **Silence Mode with Unpublished Shifts and publish them after disabling Silence Mode** - That way, workers will be notified that they were added to those shifts while Silence Mode was on. Please see our latest video giving even more input on the topic!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) πͺ
# Skillsets
Source: https://docs.roostedhr.com/guides/configuration/skillsets
What are the skillsets and how are they used?
## What Is a Skillset?
Skillsets are positions or roles that you can fill on an event. If we need 5 Servers and 2 Bartenders - the Server & Bartender would be considered separate skillsets.
## How Are Skillsets Used?
To allow your workers to sign up for or request shifts, they must assign be assigned at least one skill set. When creating an event, specify which skillsets are required - if a worker is assigned the "Bartender" skillset, they can only sign up for or request shifts designated for bartenders. Workers can have multiple skillsets - one worker can be both a bartender and a server. In this case, they will see events that require any of the skillsets they have.
## How to Create New Skillsets?
Enter the Skillset module on your blue Admin bar: Configuration - Skillsets. From this page, choose Create Skillset button, in the top right corner.
Enter the skillset name and set the default wage. The default wage - use if most workers with this skillset earn the same amount. ***The wage that differs can be assigned to a worker's profile.*** Click OK and the skillset is created.
## Editing Skillsets
From the skillset module, click the wrench on the right side.
Here you can:
* **Default skillset for new worker sign-up:** When it is on, any worker signed up will be automatically assigned this skillset. Applies to workers who have signed up, won't affect workers imported or created manually.
* **Default Time:** Set a default start time: anytime this skillset is added to an event, chosen start time will appear automatically.
* **Default Payroll Group:** A skillset can be assigned to a specific payroll group. It is an automated process upon creating a skillset.
* **Sign-Up Bot:** Sign-Up Bot can contact your workers Automatically or manually. If you select manually, an additional box will appear next to Skillset.
From this section, workers can be assigned manually by dragging and dropping the name up or down the list. If you are using the manual setting, any newly created workers will show at the bottom.
* **Useable in Client Portal:** Choose if the skillset is available for your clients to request in an order in the client portal.
* **Default skillset comments:** Enter default skillset comments, which will appear whenever you add this skillset to an event. This is useful for specifying ongoing requirements, such as uniform guidelines.
Click More to discover 3 more options for the skillsets:
* **GIVE TO ALL:** Will assign skillset to all workers in your company.
* **REMOVE FROM ALL:** Will remove skillset from all workers in your company.
* **DELETE SKILLSET:** Will delete the skillset from your skillset list. If you delete a skillset, it can no longer be used when creating shifts or adding skillsets to workers. Existing shifts won't be affected.
In the main skillset module, see two other options which are called Fallback Skillset & Fallback Period.
## Fallback Skillset
It is a secondary skillset, that can be added to a main skillset: your Bartender could have a Fallback skillset of Lead Bartender if the position isn't filled within a certain amount of time.
## Fallback Period
Fallback period - the number of days before the shift start time that the fallback skillset will come into action.
For example: if the fallback period is 7 days, all workers who have the Bartender skillset will be able to see, sign-up for or request Lead Bartender shifts within those 7 days. If you wish to have fallback skillsets and fallback period added, please contact your Client Support Specialist or send a support ticket using the need help tab.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) β€οΈ
# Text Message Notification - Options
Source: https://docs.roostedhr.com/guides/configuration/text-message-notification-options
How to manage your workers communications via Text messages.
In this article, we will explain how to enable or disable various text message notifications for workers through your settings. These notifications can serve as reminders or provide information and are only sent to workers who have disabled push notifications or have not installed the app.
They can be managed from **Configuration - Settings - Worker Communication - Text Message Notification Options**. From this page, you can toggle the following notifications on or off.
## Worker Removed from Shift
When enabled, workers will receive a text message when they are removed from a shift.
## Worker Added to Shift
When enabled, workers will receive a text message when they are added to a shift.
## Worker Added as an Alternate on a Shift
When enabled, workers will receive a text message when they are added as an alternate on a shift.
## Worker Removed as an Alternate on a Shift
When enabled, workers will receive a text message when they are removed as an alternate on a shift.
## Worker Converted from an Alternate to a Regular Shift
When enabled, workers will receive a text message when they are moved from an alternate position to a regular shift. For more information, see **[Alternates](https://support.roostedhr.com/en/articles/9497045-alternates)**.
## Punch In Soon Notification
When enabled, workers will receive a text message reminding them to punch in soon. Adjust the time frame using the sliding scale below the toggle.
## Punch In Forgotten Notification
When enabled, workers will receive a text message if they forget to punch in a set time after their shift starts. Adjust the time frame using the sliding scale below the toggle.
## Punch Out Soon Notification
When enabled, workers will receive a text message reminding them to punch out a set time before their shift ends. Adjust the time frame using the sliding scale below the toggle.
## Punch Out Now Notification
When enabled, workers will receive a text message at the end of their shift (if an end time is specified) reminding them to punch out immediately.
## Punch Out Forgotten Notification
When enabled, workers will receive a text message if they forget to punch out after a certain time after their shift has ended. Adjust the time frame using the sliding scale below the toggle.
If you need to adjust the times on the sliding scales to a larger range, please open a support ticket.
For any questions or additional assistance with your Roosted account, contact your Client Support Specialist or reach out to our support team at [support@roostedhr.com](mailto:support@roostedhr.com). π
# Venues
Source: https://docs.roostedhr.com/guides/configuration/venues
Adding, Editing, and Deleting Locations.
In this article, we will explain how the Venues in Roosed work. Venues are the locations where your events take place. Each venue includes details such as the name, address, timezone, and any additional comments you may want to include.
To view and manage your venues, go to **Configuration - Venues**. From this section, you can easily search for, add, edit, and delete venues.
Please keep in mind that **TIMEZONE IS VERY IMPORTANT FOR PAYROLL,
NOTIFICATIONS, AND FOR YOUR WORKERS TO BE ABLE TO PUNCH IN AND OUT.**
## Searching Venues
To search for a particular venue, click and type into the search bar in the top left corner and press enter to search.
## Adding Venues
To add a new venue, click CREATE VENUE in the top right corner. From here we can input the venue details and venue comments.
## Import Venues
Venues can easily be imported. The files can be clicked and dragged. The import process is quick and easy.
## Venue Details
Venue details will include name, address, and the timezone.
We can also assign a Default Client, set areas, and add a color it's color: **Default Client** It is useful to assign a client for tracking purposes, invoice reports, or the client portal.
### Areas
Areas can be assigned to a venue - it can filter workers only from certain areas to view and sign up for or request shifts.
### Color
Colors can also be used and assigned to clients.
### Venue Comments
Venue comments can be used for specific information, such as parking or entrance details.
## Editing a Venue
To edit a venue click the wrench to the right - here, any of the Venue Details & Comment can be updated.
## Deleting a Venue
To delete a Venue click the wrench on the right side - delete - OK.
And that's how you can use venues in Roosted. Make sure to check our video explaining the topic inside out!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Worker Calendar Settings
Source: https://docs.roostedhr.com/guides/configuration/worker-calendar-settings
Adjusting Worker Calendar Settings in Roosted
In this article, we will discuss how to adjust workers' ability to submit various requests through the Worker Calendar:
## View/Submit Availability
1. Navigate to **Configuration -> Settings -> Worker Interaction -> Availability**.
2. Toggle the **Availability system active** setting on or off.
3. If toggled on, workers can submit their availability through the Worker Calendar.
4. If toggled off, workers will not be able to submit their availability.
## View/Submit Time Off Requests
1. Navigate to **Configuration -> Settings -> Worker Interaction -> Time Off Requests**.
2. Toggle the **Time Off Requests** setting on or off.
3. If toggled on, workers can submit time off requests through the Worker Calendar.
4. If toggled off, workers will not be able to submit time off requests.
## View/Submit Time Punches
1. Navigate to **Configuration -> Settings -> Time Tracking -> Worker Hours Display**.
2. Toggle the **Active** setting on or off.
3. If toggled on, workers can add time punches through the Worker Calendar.
4. If toggled off, workers will not be able to see or submit time punches.
## View/Submit Reimbursements
1. Navigate to **Configuration -> Settings -> Time Tracking -> Reimbursements**.
2. Toggle the **Active** setting on or off.
3. If toggled on, workers can submit reimbursements through the Worker Calendar.
4. If toggled off, workers will not be able to submit reimbursements.
This is how you can adjust the Worker Calendar settings in Roosted.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π₯Έ
# Worker Hours Display
Source: https://docs.roostedhr.com/guides/configuration/worker-hours-display
Workers to view their tracked hours and their future scheduled hours.
## Worker Hours Display
**Worker Hours Display** is a feature that allows workers to view their tracked hours and their future scheduled hours. To adjust this setting:
1. Navigate to **Configuration**.
2. Select **Settings**.
3. Go to **Time Tracking**.
4. Click on **Worker Hours Display**.
You can toggle this feature on or off by clicking the **Active** toggle.
## Show Future Expected Hours
This option lets workers see the future shifts they have been assigned or signed up for. If this is toggled off, the related settings will be disabled.
## Use Multiple Shifts Per Day Assumed End Time
This setting calculates hours for shifts without an end time based on the length of shifts set in the Multiple Shifts Per Day slider. This helps workers see their future expected hours accurately See **[Multiple Shifts Per Day](https://support.roostedhr.com/en/articles/9491344-multiple-shifts-per-day)** for more information.
## Allow Workers to Submit, Request Edits, and Request Deletions of Past Punches
This feature enables workers to suggest edits to their time punches for admin approval.
These settings provide a comprehensive overview of the Worker Hours Display feature in Roosted! π
# Getting started with Roosted!
Source: https://docs.roostedhr.com/guides/getting-started/getting-started-with-roosted
Get to know Roosted and begin scheduling!
When you first log in to your Roosted account, enable **Silence/Testing Mode** to familiarize yourself with the platform without the stress of sending unwanted messages.
## Initial Steps:
1. **Skillsets Module:** Visit the Skillsets Module and create a few skillsets to get started.
2. **Workers Module:** Visit the Workers Module to add workers to your account, whether they are real or test profiles. Add some skillsets to their profiles. See **[Creating Workers](https://support.roostedhr.com/en/articles/9491830-manually-creating-new-workers)** for more information on the different ways you can add and create workers.
3. **Scheduling:** Start scheduling events, adding shifts, and assigning workers!
You are well on your way to utilizing Roosted for all your Scheduling, Payroll, and HR needs! For more next steps, please see **[What's Next](https://support.roostedhr.com/en/articles/9497405-what-s-next)**. Make sure to check out our walk-through video!
Good luck, and if you ever need assistance, please do not hesitate to contact your Client Success Specialist or open a support ticket! π
# Need a hand?
Source: https://docs.roostedhr.com/guides/getting-started/need-a-hand
How to contact Roosted team?
If you need to contact us, find the blue button with a question mark on it. It is located in the bottom left corner.
Click and you will see our Help Section & you will have 2 options:
## Self Help and Support
### **Self Help**
In the **Self Help** section, youβll find a variety of support documentation organized into categories. You can easily search for specific topics using the search bar at the top of the Help section.
### **Support Tickets**
If you canβt find the answer you need, you can contact our support team by following these steps:
1. **Click** on **Support Tickets**.
2. **Fill in** your information and query.
3. **Click** **Continue**.
The system will suggest relevant articles to address your query. If these articles do not resolve your issue, click **Send Conversation** to submit a support request.
## **Continuous Improvement**
Our help system gets better over time as we update it with more useful information. Be sure to check back often for new updates and resources. π
## **We're Here to Help**
If you encounter any difficulties or have questions, don't hesitate to reach out. Weβre always available to assist you with whatever you need. Feel free to explore and get familiar with the help system to make your experience with Roosted as smooth as possible.
# What's next?
Source: https://docs.roostedhr.com/guides/getting-started/whats-next
How to get the most out of Roosted?
There are a lot of different workflows available in Roosted, as well as different ways to customize your account. Please see **[Workflows](https://support.roostedhr.com/en/articles/9497187-workflows)** for more information.
Start by checking out Configuration to get a sense of what's available through your Roosted account. Please see the **[Configuration Module](https://support.roostedhr.com/en/articles/9491100-configuration-module)** for more information.
Next, check out the Time Tracking Module to get a feel of how worker punches appear from an admin side and how you can use this to streamline your payroll process. Please see the **[Time Tracking Module](https://support.roostedhr.com/en/articles/9497248-time-tracking-module)** for more information.
If you have gotten this far and dived deep into the above...good on you!!π₯³ If you get stuck, come back here to help or reach out to us by contacting your Client Support Specialist or open a support ticket! π
# Event Reviewer
Source: https://docs.roostedhr.com/guides/reviews/event-reviewer
Review your events and workers for the better results!
For every event you create, you can assign a **Reviewer**. This person will be on-site and is trusted to submit 1-5 star reviews, provide comments, and mark workers as late or absent.
## Key Points:
* The Reviewer does not need to be an admin but must have a Roosted profile.
* To assign a Reviewer:
1. When creating or editing an event, click on the **Reviewer** field.
2. Enter the name of the person you want to assign.
3. Once assigned, a red **X** will appear to the right of the Reviewer box if you need to remove them.
Depending on your company settings, you can allow the Reviewer to punch workers in and out if they have difficulty using their mobile devices. To enable this setting:
1. Navigate to **Configuration**.
2. Go to **Settings**.
3. Select **Time Tracking**.
4. Turn on **Allow reviewers to punch in/out workers on their shifts**.
See **Time Punches** for more information. If a worker is assigned as an Event Reviewer, they can view their Pending Reviews on their homepage after the event has finished. Access is possible from both, the Desktop and Mobile App from the profile or dashboard view. See **Admin/Owner Dashboard** for more information.
## Submitting Reviews
A list of events awaiting reviews for will show in the Pending Reviews section.
After an event finishes, reviewers can access their pending reviews from their Dashboard. Hereβs how they can review:
1. **Select the Event**: Youβll see details including the event name, location, and date. Click **Review** to start.
2. **Enter Review Details**:
3. **Star Rating (Required)**: Choose a rating from 1 to 5 by hovering over the stars and clicking to select.
4. **Comments (Optional)**: Add any comments about the worker(s) in the comments box.
5. **Late (Optional)**: Toggle **Late** on if the worker was late. This will turn the toggle yellow.
6. **No Show (Optional)**: Toggle **No Show** on if the worker did not attend their shift. This will significantly affect the workerβs overall rating and be noted by admins for future scheduling.
7. **Flag for Review (Optional)**: Toggle **Flag for Review** on if there are issues with the worker that HR should address. This will notify admins via email.
8. **Submit Reviews**: Ensure you have provided at least a star rating for each worker. Click **Submit Reviews** to finalize.
Once you submit a review, the event will be removed from the **Pending Reviews** list, while other pending reviews will remain. You can control the visibility of star ratings and comments for workers by going to **Configuration** - **Settings** - **Worker Interaction** - **Reviews & Stars Visibility**. See **[Reviews & Stars Visibility](https://support.roostedhr.com/en/articles/9491480-reviews-and-stars-visibility)** for more information. And that is how you use an Event Reviewer to get feedback on your workers through Roosted! π
# Event Reviews & Feedback
Source: https://docs.roostedhr.com/guides/reviews/event-reviews-feedback
How to rate your workers and how will it impact them?
Event reviews are left for workers can count toward the overall star rating. Reviews can be left by:
1. Event Reviewer
2. Admins
## Event Reviewer
For every event that you create, you can assign a Reviewer - someone who will be on-site at the event will submit reviews, and comments, mark a worker as late or a no show. The worker you assign as the Reviewer on an event does not need to be an admin, just needs to have a profile on your account. See **[Event Reviewer](https://support.roostedhr.com/en/articles/9491947-event-reviewer)** for more information. If a worker has been designated as an Event Reviewer, they can see their Pending reviews on the homepage of their Desktop or Mobile Browser:
## Admins
If an admin has been designated as a reviewer for an event, they can view their Pending reviews from their Dashboard. To access this, click on the Dashboard in the blue admin bar on the left-hand side.
An admin can also edit previous reviews by following these steps:
1. Worker's profile in the Workers Module
2. Edit icon (wrench)
3. Schedule
4. Past Shifts
## Submitting Reviews
An admin can adjust star ratings, comments, and update the status of whether a worker has been marked as Late, Absent, or Flagged for Review.
To begin reviewing, click Review and enter the following:
* **Star Rating (Required)**
* Rate between 1-5 stars by hovering over the desired rating and clicking to select.
* **Comments (Optional)**
* Any comments about the worker - click the comments box and type your feedback.
* **Late (Optional)**
* If the worker is late, toggle Late on. It will appear as a yellow toggle.
* **No Show (Optional)**
* If the worker didn't show up for their scheduled shift, mark them as a NO SHOW by clicking the toggle. This significantly impacts the worker's overall star rating and is visible to admins during future scheduling.
* **Flag for review (Optional)**
* If there is an issue with a worker that HR should be aware of, toggle **Flag for review**. An email will be sent to the admins after submitting.
After completing the reviews and ensuring that each worker has been given at least a 1-5 star rating, click Submit Reviews.
This event will then disappear from the Pending Reviews list. You can control the visibility of star ratings and comments to workers. To do this, navigate to Configuration -> Settings -> Worker Interaction -> Reviews & Stars Visibility. See **[Reviews & Stars Visibility](https://support.roostedhr.com/en/articles/9491480-reviews-and-stars-visibility).**
**Client Feedback**
If your client is using the Client Portal, they can also provide feedback on workers who have worked at their events. When your client clicks Order Details on a previous order, they will see a list of workers who worked on that event.
From here your client can either give the worker a green thumbs up which will mark them as preferred or a red thumbs down which will mark them as banned.
When a client Prefers Or Bans a worker, this is a suggestion - the worker will not automatically be preferred or banned for that client. An admin or owner account can choose to accept or ignore this feedback from their **Dashboard**.
# How Do Reviews Affect My Workers
Source: https://docs.roostedhr.com/guides/reviews/how-do-reviews-affect-my-workers
Good and bad reviews - how will they impact my workers?
One of the unique features of Roosted is its worker review system. When used effectively, these reviews help Roosted staff your shifts in a balanced and efficient manner.
**A Good Review**
A positive review helps workers build a higher rating. Over time, this can elevate them into higher categories, allowing them to sign up for shifts further in advance.
**A Bad Review**
Conversely, a negative review lowers a worker's rating. If a previously well-rated worker receives consistently bad reviews, they will drop to lower categories and need to work harder to regain their previous perks.
**Conclusion**
Reviews are a crucial part of the scheduling process. They directly impact both your workers and your business. It is essential that reviews are entered in a fair and honest manner, either by you or a highly trusted employee.
# Star Ratings
Source: https://docs.roostedhr.com/guides/reviews/star-ratings
Each of your workers has a star rating next to their name, which is vital for Roosted to function at its highest level. Star Ratings are generated using the following data:
* **Seniority**: The worker's level of experience and tenure.
* **Number of Shifts Worked**: The total shifts a worker has completed.
* **Bailouts**: If a worker bails out within 72 hours before a shift start time, it will negatively affect their overall star rating over time. See **[Bailouts](https://support.roostedhr.com/en/articles/9497156-bailouts)** for more information.
* **Lateness:** If a worker is marked as late, this will reduce their score and overall star rating.
* **No Show:** If a worker doesn't turn up for a scheduled shift and is marked as a no show, this will significantly reduce their score and overall star rating. A no show has the largest impact on a worker's star rating.
* **Event Star Ratings:** Star ratings left for workers will affect their overall score:
1. A score of 3 stars is neutral.
2. Below 3 stars is negative.
3. Above 3 stars is positive.
When you create an event, you should assign one worker (doesn't need to be an admin) to be the **[Event Reviewer.](https://support.roostedhr.com/en/articles/9491947-event-reviewer)** You should always choose a manager or team captain to be your reviewer and emphasize the importance of providing honest ratings. After each shift, Roosted will prompt the reviewer to give each one of your employees a rating of 1 to 5 Stars. See **[Event Reviews & Feedback](https://support.roostedhr.com/en/articles/9491944-event-reviews-feedback)** for more information. With time, Roosted uses these reviews along with other factors, to rate each worker and ensure that every shift is staffed correctly! π
# Agency Placeholders
Source: https://docs.roostedhr.com/guides/scheduling/agency-placeholders
Using Agency Placeholders in Your Scheduling Process
In this article, we will discuss what Agency Placeholders are and how you can use them in your scheduling process.
## What Are They?
Agency placeholders are workers from outside agencies who are helping with certain events or shifts. You can to add their information to your account and store it for events.
## How Can I Use Them?
On each shift, you have the option to **ADD PLACEHOLDERS**. This feature allows you to store information about these external workers **without a need to create Roosted accounts for them**, ensuring they do not count towards your usage total.
## How Do I Add Them?
When scheduling an event, you will see an **ADD PLACEHOLDERS** button on each shift you create. Click this button to add the necessary details for agency workers.
When you click it, you will see an optional form to complete, with details such as an Agency Name, Worker Name, Worker Email & Worker Phone.
When you have completed entering the information, you can:
* SUBMIT AND ADD ANOTHER - will add the first worker and display a new blank form
* SUBMIT - will save the information and bring you back to the previous screen
* CANCEL - will cancel and not add the information you have entered
When you have submitted the information, the placeholder(s) will appear as shown below.
## Placeholder Time-Tracking
You can add time punches to placeholders and share a link with an agency, to allow them to punch in. When you add a placeholder position, you will see a time-tracking password, a time-tracking link, and a time-tracking total.
You can share the link with a worker by clicking EMAIL LINK. When you do this, the time-tracking link will be sent to the email address that was added to the '*Worker Email*' section - using this method you won't need to share the Time-tracking password, as it the worker will log in via the link directly. You can also provide the worker with the generic login link: [Roosted Agency Login](https://login.roostedhr.com/agency_login).
Here, they will have to input their email and password - if you use this method, you will need to provide the worker with the password chosen in the settings. You can also add time punches to these shifts by clicking ADD PUNCH & following the same process for regular worker time punches.
## Deleting a placeholder
Click the placeholder you want to remove and click the Delete button. When deleting a placeholder the system will **NOT** ask you **to** confirm, deletions are carried out with **ONE CLICK** and cannot be undone - if you delete by accident you will need to re-enter the information.
And that is how you can use Agency Placeholder through Roosted.
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€
# Alternates
Source: https://docs.roostedhr.com/guides/scheduling/alternates
How to set up a Plan B for your events.
**Alternates** are backup workers that you can treat like on-call staff. This allows you to add workers that fill in anyone who bails out of a shift. This is a completely automated process, you only need to set the number of alternates you want to have.
## Adding Alternates
You can add an alternate to a shift in the same way that you a worker directly to a shift through **Direct Assignment**. Increase Alternates to how many you would like.
Add the workers you want as an alternate directly, by clicking *Click to Fill.* On the next page, select the 2 workers by clicking their names and Add Selected.
The alternates will then appear as below.
## 4 Ways an Alternate is moved to a shift:
## **1. Worker bails out**
When a worker bails out, Roosted will automatically replace them with an alternate with that skillset. So, in the picture below, if Adam bails out Booker would replace him.
## **2. Admin removes a worker with a penalty:**
When you remove a worker by bailout, Roosted will automatically replace them with an alternate. In the below case, if an admin has removed Adam with a Bailout, Booker will take his place.
## 3. Converting an Alternate to an open spot.
You can convert an Alternate to an open spot. In the example below, we have 1 open spot and 2 alternates.
If you want to convert Annabelle to the open spot, you can click the box with the worker name & click convert.
This will then convert Annabelle from an alternate to fill out the open spot & will appear like below.
## **4. Manually moving the alternate to a worker**
Use a basic remove on the original worker and the alternate, and assign the worker that used to be the alternate to the skillset. So in the picture below you could remove Brice as a worker, remove Adam as an alternate and then add Adam as a worker to the shift to Click To Fill.
And that is how you use Alternates through Roosted! π
# Approving Shift Requests
Source: https://docs.roostedhr.com/guides/scheduling/approving-shift-requests
How to approve shift requests?
In this article, weβll cover how to approve shift requests. Shift requests are shifts that workers have asked to work. Shift requests can be approved in two ways.
1. On the event
2. In **[Request Manager](https://support.roostedhr.com/en/articles/9497058-request-manager)**
## On the event
Through the event edit screen, you can approve a request by clicking an open spot.
You can filter to only show workers who have requested the shift by clicking the check box that says 'Only show requests'.
To approve the request click on the worker and choose add selected.
The worker will be added to this shift.
## In Request Manager
You can filter and view shift requests in various ways:
**Show Requests:** Click the dropdown menu to the right of the blue arrows to choose how to display requests. You can select from:
* Shift Date
* Worker Name
* Location
* Event
To approve a shift request, click the blue tick next to the worker's name on the request and then click "Confirm."
When you accept a worker for the last open spot and there are other workers who have also requested the shift, the system will prompt you to choose whether to leave the remaining workers as backups or reject their requests.
# Bailouts
Source: https://docs.roostedhr.com/guides/scheduling/bailouts
Bailouts and how your workers can resign from the shift.
Roosted has a partially automated bailout system for your benefit.
## What are bailouts?
A bailout is a worker removing a shift from their schedule.
## How does a worker bailout from a shift?
### Desktop
A worker can bailout from a shift in "Go To My Shifts" - "Bailout" and "Bailout" again to confirm.
A confirmation message will appear to inform them that if they Bailout, it may affect their ability to be scheduled for future events. This Bailout message is customizable through your settings.
### Mobile App
Current shifts - scroll to the event to Bailout from & tap Bailout. It will display the same warning message, the bailout must be confirmed by tapping "Bailout".
## How can admins bail workers out?
An admin can also bail out a worker. This is useful if bailouts are locked and you still want to impose a penalty on the worker for late notice of their inability to work.
### Event Page
Admins can go to the main edit event page, scroll down, and click on the worker in question. Then, click **Bailout**. Please note that it will not ask for confirmation; the worker will be bailed out with one click.
### Workers Module
You can bailout workers in the workers module from the admins bar. Click the wrench on the right side on the worker - Schedule - Future Shifts - Bailout & Confirm.
## Impact of bailing out of a shift
Bailing out from a shift has different impacts, primarily depending on how often and when the worker bails out. If a worker bails out a week before the event, there is a penalty, but if they bail out the day before, the penalty is much more severe. You can adjust bailout settings on your account to suit your preferences.
Please see **[Bailout Settings](https://support.roostedhr.com/en/articles/9491447-bailout-settings)** for more information. Bailouts can also be selectively turned on or off through the **[Main Event Page](./main-event-page)** under Options.
And this is how bailouts work through Roosted! π
# Calendar View
Source: https://docs.roostedhr.com/guides/scheduling/calendar-view
What are the perks of the Calendar view?
The Calendar View is our most used scheduling view and allows you to see a clear list of all events, shown comfortably on a calendar. Upon creating the first events, they will appear on your calendar:
Blue event means the shift is fully staffed and published, and yellow indicates events with unfilled and unpublished shifts. Please see **Shift Publishing** for more information. **Unfilled Openings symbol:** shifts still need to be filled
**Unpublished**: shifts have not been published
Events can be filtered in several different ways. See **[Calendar View Search & Filtering Options](./calendar-view-search-filtering-options)** for more information. Other Calendar View options: **Show All Events**
Click SHOW ALL EVENTS, select a start date, and see all the events matching your filters.
A list of all the events will appear below the calendar:
Edit the event by clicking View/Edit or Print timesheets broken down by individual worker or a Master Timesheet with all workers listed. See the workers who already checked in\*, *and* \*how many workers are scheduled for the total event. You will also be able to see if shifts have not been published yet. See **[Shift Check In Bot](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot)** for more information
You can always change back to showing the calendar by clicking Show Calendar at the top of the page.
## Creating an event in Calendar View
To create an event in Calendar View:
* Click CREATE EVENT on the top left corner,
* On the calendar, choose the day and click the + sign.
Fill up the event details: Event Name, Job ID, Event Date, Venue, Client and Areas\*\* \*\*
After clicking CREATE EVENT, the Event Interface will show - from there you can fill rest of the details and create shifts. Please see **Main Event Page** for more information.
## Editing an event in Calendar View
* click View/Edit on an event or the list,
* hover over an event and click the wrench icon.
By clicking edit either of these two ways, it will bring you the the **Main Event Page**. Please see the video explaining the topic even further:
And this is how you can use Calendar View to view, filter, create and edit events through Roosted! π
# Calendar View Search & Filtering Options
Source: https://docs.roostedhr.com/guides/scheduling/calendar-view-search-filtering-options
How to filter events in the calendar view?
The Calendar View page will allow you to filter your events in several different ways.
**Search by Event Tag:** Event tags can be added to individual shifts as a way of filtering and organizing your events. See **[Event Tags](https://support.roostedhr.com/en/articles/9497054-event-tags)** for more information.
**Search Event Names:** You can search by the event name.
**Search Venue Names:** You can filter your events by searching the Venue.
**Areas:** You can filter and organize your event areas to be associated with an event. See **[Areas](https://support.roostedhr.com/en/articles/9491866-areas)** for more information.
**Show only unfilled events** Only see the events that have unfilled openings - helpful to identify events that require your attention. And this is how you use Calendar View Search & Filtering Options through Roosted! π
# Copying Events
Source: https://docs.roostedhr.com/guides/scheduling/copying-events
If you have recurring events or shifts, it is very simple to copy these to multiple days.
Copying Events & shifts has never been easier! If you have recurring events or shifts, it is very simple to copy these to multiple days. From the **[Main Event Page](https://support.roostedhr.com/en/articles/9497024-main-event-page)**, under Actions, click Copy Event:
### Selecting Dates to Copy Events
From the calendar, choose the days you want to copy the event to by clicking on each day. The selected days will appear in dark blue.
## Invite Status Options
In this section, you will be asked the following:
## Do you want all workers on shift to be invited?
* **Toggle On:** Everyone currently scheduled for the event you are copying will be invited to work on the new dates (e.g., Jan 27th, Jan 28th, and Jan 29th in the example).
* **Toggle Off:** The status of workers will remain the same as on the original event. For example, if a worker is Directly Assigned, they will remain directly assigned on the copied dates. If a worker's status is PENDING INVITE, it will stay the same on the copied dates.
## Do you want to link events and shifts?
* **Toggle On:** The shifts will be linked across all the dates you copy the event to. Workers will have to request all linked shifts together. (See Linked Events for more information).
* **Toggle Off:** An individual event will be created for each date you copy the event to.
## Do you want all shifts/skillsets to be unpublished?
* **Toggle On:** You can edit the copied events before publishing them.
* **Toggle Off:** All skillsets/shifts will be published immediately. Workers already scheduled (not invited) will receive notifications for the new shifts. Invited workers will be notified about their invitation for the new dates.
You can easily create event templates and copy them to relevant dates using Roosted. For more information, please contact your Client Support Specialist. Check out our latest video expanding the topic to the fullest: And this is how quick & easy it is to copy events to multiple days through Roosted! π
β
# Deleting Shifts & Events
Source: https://docs.roostedhr.com/guides/scheduling/deleting-shifts-events
How to permanently delete a shift or event in Roosted?
You can delete individual shifts (skillsets) or an entire event all at once.
Deleting a shift or event is irreversible.
## Deleting a Shift
To delete an individual shift (skillset), click the trash can icon on the right side of the blue bar. This will remove specific shift (skillsets). You also have the option to send a notification message upon deletion.
## Deleting an Event
To delete an entire event: click the *Actions* button on the edit page, and choose Delete Event. You can choose to send a message upon deletion.
And this is how you can delete shifts & events through Roosted! π
# Editing An Event
Source: https://docs.roostedhr.com/guides/scheduling/editing-an-event
How to edit your event in various views offered by Roosted.
In this article, we will explore the various methods for editing an event in Roosted, depending on the view you are using. **Calendar View:** In Calendar View, you can edit an event in two ways:
1. **Edit a Single Event**: Click on VIEW/EDIT for the specific event you want to modify.
2. **Edit Multiple Events**: Click SHOW ALL EVENTS in the top left side to view and edit a list of events.
You can choose the event you want to edit on the calendar and click the wrench icon.
## Side By Side View
When you have an event selected from the top menu, you can edit it using the following options:
* **ADD SKILLSET/SHIFT**: Use this to add or modify skillsets and shifts for the event.
* **DETAILS**: Click alongside the skillset to change the start time or quantity of a shift.
* **DETAILS (View/Edit Event Details)**: Click here to view or edit the general event details.
* **DOCS**: Click this to edit or upload documents related to the event.
## Spreadsheet View
In Spreadsheet View, hover over any detail to edit that particular event.
## Grid View
In Grid View, choose a worker shift, and click the wrench to View/Edit Shift.
When you edit events either through Calendar View, Spreadsheet View or Grid View, you will be redirected to the edit page of the particular event. Please see the **[Main Event Page](https://support.roostedhr.com/en/articles/9497024-main-event-page)** for more information.
# Event Tags
Source: https://docs.roostedhr.com/guides/scheduling/event-tags
How to tag your events for better filtering.
Tags for events allow easy filtering and make searching through calendar or other views way easier.
## Add event tags:
**Main Event Page:** chooses the field called *add event tag*. Directly in this field, you can type a new tag, created on-the-spot, or use a previously created one. After choosing the tag, press enter and choose a color.
## To filter by event tags
On **Calendar View**, use the field called *search event tag:*
On **Side By Side View**, click the filter icon in the top left corner - *search event tag* - Apply.
On **Spreadsheet View**, click FILTER, *search event tag* - APPLY.
If you have to delete or modify your tags, please contact your Client Success Specialist or open a support ticket. See our video showing even more details on the topic:
β
β
# Grid View
Source: https://docs.roostedhr.com/guides/scheduling/grid-view
Perks of using the Grid view - another possibility of seeing your events.
This view is the best for scheduling back office or daily staff. It also provides hour and cost breakdowns at a glance.
## What Grid View is good for:
* Grid View can give you a spreadsheet-like view that is similar to Excel.
* Back office staff, support staff, or staff with shifts at the same or similar time every day.
* Chefs that start every day at 9 am in the same kitchen. Or office staff that works 10 in the morning to 6 in the afternoon.
## What Grid Scheduling is NOT good for:
* The vast majority of customers use Calendar View for most shifts.
* Event-based scheduling
## Grid View Features:
**Daily totals** - Totals for the day are displayed at the top - get a quick overview.
**Worker totals** - Next to each worker the shift time totals and wage totals are displayed.
**Filtering** - The filter icon at the top - filters the workers you want to see.
**Open Spots** - This will show the number of Open Spots on each day. Click on any day and see the list with open spots - you can drag them to a worker to assign.
**Solo shifts** - These are shifts created in the grid view that are not associated with any events. They are a darker blue color than event shifts. Solo shifts are often used for scheduling office staff, admins, warehouses, etc. Anyone with more regular weekly hours.
**Event shifts** - These are shifts that are associated with an event and appear as a light blue box.
**Drag and Drop** - This allows you to drag and drop shifts on the schedule. Solo shifts can be dragged around to any day or worker. Event shifts can only be dragged around the same day the shift occurs on.
## Grid View Filtering Options
This is how you filter what you see on Grid View.
**Worker Areas:** This will only show the workers that can work in the areas selected.
**Worker Skillsets:** This will only show the workers that have the selected skillsets.
**Worker Tag:** This will show only workers that have one or more of the tags to have entered here.
**Custom Fields:** You will have the ability to filter using custom fields that you have created on your account. i.e if you wanted to see all workers that DID NOT have Facial Hair, you would enter & APPLY and shown below which will filter the list of workers for you.
And this is how you can use Grid View on Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π
# Linked Events
Source: https://docs.roostedhr.com/guides/scheduling/linked-events
How to link events in Roosted?
Roosted lets you link events together to synchronize details and attendees. If you need to keep the same details or people across multiple events, linking them is the solution. See our YouTube tutorial on how to link the events to each other.
**How to Create Linked Events:**
1. **Create the First Event**: Start by creating your initial event in the series as you normally would. You can add shifts, assign people, and set start times, but these details are not mandatory at this stage.
2. **Copy the Event**: From the actions button, select "Copy Event."
3. **Choose Dates and Link Events**: In the next window, you will be prompted to select the dates for the copied events. Enable the option titled "Do you want to link events and shifts?" to ensure the events are linked.
By following these steps, your new events will be linked, allowing for synchronized details and shifts across the series.
β
## What's different for you (admins):
When you link events together in Roosted, changes made to one event can impact all events in the linked series. Each data field, such as comments, client details, number of workers, and arrival times, can be either linked or unlinked. If the fields remain linked, the data will sync across all events in the series. When you make changes to a specific field, you will have the option to either:
* **Update Only That Event**: This will unlink that particular field from the others.
* **Update All Events in the Series**: This will apply the changes to all linked events, keeping the data synchronized.
## What's different for workers:
Workers who sign up or request to work on linked events will have to work all shifts in that series: if you've linked shifts for Monday, Tuesday, and Wednesday, a worker requesting those shifts will be required to take all three days, rather than selecting them individually.
# Main Event Page
Source: https://docs.roostedhr.com/guides/scheduling/main-event-page
What are the features of it?
The Main Event Page is where you can make changes and edit your event. On the main event page, you will see all the details that you entered originally along with a map of the selected venue.
In addition to the details that have already been created, you can:
* Add a comment template (recurring information for events)
* Add event admin(s)
* Add event tags (for filtering and sorting events)
* Add event comments for workers (information for all workers on the event)
* Add event comments for admins (internal information for admins)
When you add a comment template or event comments for workers, be sure to click **Update Event Comments for Workers** as shown below.
## Options
* **Geofencing Enabled**
Collect location details of workers when they punch in and out, so you can accurately track who was on site and their times of punching in and out. If Geofencing is already enabled in your settings, it will be automatically turned on in the "Options" section.
* **Allow Worker Time Punches**
Control whether workers can punch in and out for specific events. If toggled on, workers can punch in and out. If off, workers cannot punch in or out, and the assigned **Time Tracking Manager** or an admin must submit time punches for them. If worker time punches are enabled in your Time Punch Settings, the *Allow Worker Time Punches* toggle will be automatically on in the Options section of the event.
* **Bailouts Locked**
Prevents workers from bailing out of the event without contacting HR or a member of management. If bailouts are disabled in your **Bailout Settings**, this option will be automatically turned on in the Options section of the event.
## Documents
Upload files or documents to be viewable and downloadable by all workers on this event. There is no limit to the type of file you can upload, there is a max file limit of 50MB.
## Add Skillset/Shift
Add shifts for this event - click Add Skillset/Shift - and Select from the dropdown of Skillsets that you have added to your account.
If you have created **Shift Templates** - they will appear at the top of this dropdown list and you can select which template you would like to use.
Select a skillset template from the dropdown menu, it will automatically populate below. For example, selecting "General Crew" will display the details immediately underneath.
You can change the start time by clicking the existing date and time then use the up & down arrows on the hour, minutes and whether it is AM or PM.
You can add an optional end time for the shift and adjust it in the same way as the start time. To adjust the number of workers, click the blue **arrow** button to increase the quantity. If you need to reduce the number after it exceeds 1, click the blue **down** button.
You can add multiple skillsets or shifts, adjust start and end times, and increase or decrease the number of workers using the same method described above. Similarly, you can adjust the number of alternates for the shift. For more information on **[alternates](https://support.roostedhr.com/en/articles/9497045-alternates)**, please see the relevant article. In the example above, there are 4 open shifts that need to be filled. Check out the **Workflows** section to explore different ways to fill these positions. To delete shifts, click the trash can icon as shown below.
## Actions
**Contact Workers:** This feature allows you to contact all workers assigned to this event via email, text message, or both.
**Print Timesheet:** This option lets you print timesheets for individual workers as well as a master timesheet listing all workers.
**Email Openings:** Use this to email workers with the required skillsets about any open shifts for this event.
**Copy Event:** This feature enables you to duplicate the event with the same shifts for a single day or multiple days. For more details, see **Copying Events**.
**Send Client Roster:** Send a list of all workers and their positions for this event to the selected client.
**Mark as Ready to Sync:** Allow workers to sync this event to their calendar through Calendar Sync.
**Delete Event** Completely remove all details of this event. *Please Note: Deletions are irreversible.*
## Create Chat
This feature lets you create a group chat with the workers scheduled for the event. You can adjust the chat group by adding workers who join the event and removing those who are no longer assigned. For more details, see **[Event Chats](https://support.roostedhr.com/en/articles/9497302-event-chats)**.
## Reviewer
This person will be on-site at the event and is trusted to submit 1-5 star reviews, leave comments, and mark workers as late or absent. For more details, see **Event Reviewer**.
## Time Tracking Manager
This trusted on-site person can assist with punching workers in and out. For the day of the event and the following day, they can add, edit, or delete time punches.
The assigned Reviewer and/or Time Tracking Manager does not need to be an admin; they just need a Roosted account.
For each skillset, you can:
* **Add Wage**: Set a specific payment for the shift, rather than an hourly rate.
* **Hide Shift Times from Workers**: Prevent workers from seeing shift times.
You can access these options by clicking the three dots, as shown in the picture below.
Please contact your Client Success Specialist or open a support ticket if you need the Add Wage function turned on. In addition to the options above, you can include **Shift Comments**. These are specific comments or information intended for this particular worker or group of workers on this shift. You can also add a **[Comment Template](https://support.roostedhr.com/en/articles/9491130-comment-templates)** for recurring information that you regularly provide.
When you add a Comment Template or add Shift Comments, ensure that you click UPDATE SHIFT COMMENTS as shown below.
And that is the Main Event Page on Roosted! π€
# Request Manager
Source: https://docs.roostedhr.com/guides/scheduling/request-manager
In this article, we will go through the Request to Work feature. **What is it?** The Request Manager helps manage shift requests from workers and can be enabled or disabled through company settings. To access the Request Manager:
1. Go to the blue Admin bar.
2. Click on "Scheduling."
3. Select "Request Manager."
On the Request Manager page, you'll see a weekly view of shift requests, starting with the current week, and beginning on Monday. To view the following week, click the calendar and select the desired week, or use the blue arrows to navigate forward.
You can choose to show requests by Shift Date, Worker Name, Location or Event by clicking and selecting from the dropdown to the right of the blue arrows.
When you expand a request by clicking the blue box, you'll see detailed information including:
* **Name:** The name of the worker who requested the shift.
* **Event:** The name of the event.
* **Skillset:** The skillset required for the shift.
* **Remaining Spots:** Indicates how many spots are still available. For example, if 4 workers are needed and 2 spots are open, it will show as 2/4.
* **Shift Time:** The date and time of the shift.
* **Location:** The venue where the event is being held.
* **Submitted:** The date and time when the request was submitted.
* **Request Comments:** Any comments the worker has included. Note that workers can add comments based on your company settings.
**Accepting a Shift Request:** To accept a shift request, click the blue tick next to the worker's name and then click "Confirm."
When you accept a worker for the last open spot and other workers have requested the same shift, the system will prompt you to choose whether to leave the remaining workers as backups or reject their requests. For more details, please refer to the section on **[Alternates](https://support.roostedhr.com/en/articles/9497045-alternates)**.
**Rejecting a Shift Request:** To reject a shift request, click the red X next to the worker's name and then click "Reject."
Shift requests are shifts that workers have asked to take on. You can enable or disable this feature through your settings. To find and adjust shift request settings:
1. From the blue admin bar on the left side, click on **Configuration**.
2. Select **Settings**.
3. Click on **Shift Options**, and you'll find **Shift Request** at the very top.
Depending on your company settings, workers can receive a text message when their request is either accepted or rejected. Please see **[Shift Requests](https://support.roostedhr.com/en/articles/9497202-shift-request)** to find the full list of company settings.
# Rules
Source: https://docs.roostedhr.com/guides/scheduling/rules
Personalise each shift by workers' specific rules!
Rules are a way of filtering which workers can sign up or request a shift. Rules that are used for shifts can be created through **Custom Fields** or by using **Worker Tags**.
## How to apply rules?
They can be added via Custom Field or by workers tags. ***Adding a Custom Field Rule*** In the event edit page click NO RULES button:
Add a new one in '*Add new custom field rule*'. Choose which Custom Fields to apply to this shift. Only workers with these rules will be able to sign up.
After closing, the ruler will be visible at the top of the edit page.
Rules can also be displayed when filling shifts in the Click to Fill edit screen, these custom fields will appear.
***Applying Worker Tags*** Again, click NO RULES above the shift.
Select which tags you want the work to have or not. Choose from the dropdown shown by clicking on the blue buttons.
Once selected, the system will actively filter the number of workers available to sign-up for or request this shift.
After closing, rules will apply.
Please check our YouTube video on the Rules, where you can find even more detailed info:
And this is how you can use rules through Roosted π
# Scheduling
Source: https://docs.roostedhr.com/guides/scheduling/scheduling
Different ways of scheduling your events in Roosted!
In this article, we will explain all the different ways of Scheduling your events through Roosted different views.
**Calendar View** is exactly what it sounds like - provides a visual calendar of all scheduled events. It is typically where you will spend most of your time creating, viewing, editing, and filtering events. See **[Calendar View](https://support.roostedhr.com/en/articles/9496995-calendar-view)** for more information.
**Side By Side View** is a condensed view of shifts on the same day and over the next few days. Create, view, edit & filter events, and move workers between shifts. See **[Side By Side View](https://support.roostedhr.com/en/articles/9497002-side-by-side-view)** for more information.
**Spreadsheet View** gives you a complete rundown of all shifts. From here you can view, edit & filter events. See **[Spreadsheet View](https://support.roostedhr.com/en/articles/9497006-spreadsheet-view)** for more information.
**Grid View** is a retail scheduling style, from here you can create solo shifts (*shifts that are not associated with events*). This is particularly useful for staffing chefs, office staff, or warehouses among others. See **[Grid View](https://support.roostedhr.com/en/articles/9497017-grid-view)** for more information.
Please check out the links in this article to find out more information on all of the different ways you can schedule staff through Roosted! π
# Shift Check-In Bot
Source: https://docs.roostedhr.com/guides/scheduling/shift-check-in-bot
How your employers can check in into a shift?
**Shift Check-In Bot** is designed to reduce no-shows and late arrivals by asking your workers to check in online before their shifts, just like for a flight.
Roosted can email and text your workers in advance, at a time you choose, and ask them to check-in. Essential information can be emailed or viewed in real-time on your Roosted account.
Shift Check-In can be adjusted in Configuration - Settings - Worker Communication - Shift Check-In Bot. Please see **[Shift Check-In Bot Settings](../configuration/shift-check-in-bot-settings)** for more information.
## How do workers check-in?
* emails and texts are sent to each worker, asking to check-in.
* check-in can be done via mobile app or desktop
* we recommend shift check-in reminders to be sent out 2-3 days ahead of a shift
## Who checked in?
* Depending on the settings, before an event admins will receive a summary email of workers who did and did not check-in.
* On **Calendar View or Side By Side View**, you can see who checked in by a dot or a green tick box next to their name.
## A worker can't check in yet?
There are 2 reasons why a shift check-in might not be possible:
1. The shift check-in period - the check-in email/text message will not go out to workers until the shift is within the period.
2. The shift is within the check-in time, but the worker still can't check in - If you have just added the worker, it may take up to 1 hour for the shift check-in email to be sent out.
If you have added a worker to a shift that begins within 6 hours, the worker(s) will automatically be checked in. Please check our video explaining all the details!
And this is how you can use **Shift Check-In Bot** through Roosted! π
# Shift Limits
Source: https://docs.roostedhr.com/guides/scheduling/shift-limits
How to set hours and shift limits across your company or on individual workers.
In this article, we will discuss Shift Limits and how they can be used in your scheduling process.
## What are they?
Efficient scheduling and compliance with labor laws are crucial for any organization. Roosted provides a feature called **Shift Limits**, allowing you to set hours and shift limits across your company or for individual workers. This is particularly useful for managing part-time staff and controlling overtime expenses.
## Configuring Shift Limits
To set up shift limits in Roosted, follow these steps:
1. **Navigate to Settings**: Go to **Configuration** and select **Settings**.
2. **Locate Shift Limits**: Within the settings, find the **Shift Limits** section.
You can set 2 different limits:
1. **Company-Wide Limits**: Define the maximum number of hours and shifts that any worker can be scheduled for within a specified period (e.g., per week or per month).
From this section, set limits on the number of hours a worker can work in a week or in a week. In the example above, all the workers are restricted to either 40 hours or 5 shifts per week.
2. **Set Individual Worker Limits**: Customize limits for specific workers, which can be useful for part-time staff or those with specific scheduling constraints. These settings are in the **workers' profile**: Worker Info -> Limits.
From here you can set worker shift or hours limits.
## Understanding Worker Limits in Roosted
### Worker Limits Override Company Limits
Worker-specific limits always take precedence over company-wide limits. For example, if the company limit is set to 40 hours per week, but an individual worker's limit is set to 50 hours, that worker will only be flagged when they exceed the 50-hour limit.
**Included Shifts in Limits Calculation:** When calculating whether a worker exceeds their limits, both, regular open shifts and alternate shifts are included. **[Alternates](https://support.roostedhr.com/en/articles/9497045-alternates)** may automatically move up to fill open spots, impacting their total hours and shifts.
**Exceptions:** Hours and shift limits do not apply to **[Anytime Punches.](https://support.roostedhr.com/en/articles/9491858-anytime-punches)**
### How Limits Appear When Scheduling?
While scheduling events, you can see the number of hours and shifts a worker has been scheduled for in two sections:
1. **Regular Hours and Shifts**: Displayed on the left-hand side.
2. **Inclusive of Alternate Shifts**: Displayed on the right-hand side.
This dual view helps you manage and monitor worker limits effectively during scheduling.
### Can I Override the Limits?
Yes, you can override the limits. These limits are designed to provide a clear view when scheduling, but you always have the flexibility to assign and invite workers to open shifts directly. If scheduling a worker for a position pushes them over their set limits, it will be indicated as shown below.
### Impact on Sign-Up Bot & Worker Sign-Up/Request
**[Sign-Up Bot:](https://support.roostedhr.com/en/articles/9497214-sign-up-bot)** If assigning a worker to an open position would exceed their set limits (either company-wide or individual), the Sign-Up Bot will not contact that worker for the shift.
**[Worker Sign-Up/Request:](https://support.roostedhr.com/en/articles/9497202-shift-request)** Similarly, workers will not be able to sign up for or request shifts if doing so would push them over their specified limits, based on the company settings. This ensures that all scheduling adheres to the predefined limits for each worker. And this is Roosted Shift Limits.
If you have any questions or want to learn more about getting the best from your Roosted account, please contact your Client Success Specialist or the support team on [support@roostedhr.com](mailto:support@roostedhr.com) π
# Shift Publishing
Source: https://docs.roostedhr.com/guides/scheduling/shift-publishing
When is the shift ready to be published?
Our Shift Publishing feature allows you to work on and edit shifts while they are still unpublished.
Make changes and finalize details before publishing them. When youβre ready, click the button to publish the shifts. While shifts are unpublished, workers will not be notified about the available shifts. Additionally, if you add a worker to an unpublished shift or use the "Invite to Work" feature for an unpublished shift, the worker will not receive any notification. Once you publish a shift, notifications will be sent according to your settings in the configuration.
Shift Publishing settings can be found in **Configuration - Settings - Admin - Shift Publishing**. For more details, please see the **["Shift Publishing Settings"](https://support.roostedhr.com/en/articles/9491775-shift-publishing-settings)** section. See our latest video showing the topic insideout!
# Shift Templates
Source: https://docs.roostedhr.com/guides/scheduling/shift-templates
Templates that you can create to help speed up your scheduling process.
In this article, we will explain the shift templates and how you and your team can use these to automate your scheduling process.
## What are Shift Templates?
Shift Templates are tools that help speed up your scheduling process. You can create templates for different types of events, such as weddings, parties, or for clients with recurring needs.
## How to create Shift Templates?
Shift Templates can be created, edited & deleted by navigating to Scheduling -> Shift Templates.
There is no limit to the number of templates that you can create so feel free to create templates for each type of scenario that you can think of to help speed up your scheduling process! π **Creating a Shift Template** Click **ADD**, name the template and include a description.
Once you have named your template & included a description click **Add Template**. On the next page, you can begin building your template by clicking ADD SHIFT. Then, select the Skillset you would like to add to the template.
In the below scenario, we will add the Bartender, Server & Supervisor skillsets.
For each skillset, you can enter a start and ending time. Increase the Quantity needed: type the number or use the arrows on the right. You can also include Wage details and travel hours. At the bottom of each skillset, you can add comments. These comments will automatically appear when you select this template and will be visible to workers on this shift.
Always after entering new comments in this section UPDATE SHIFT COMMENTS to save - otherwise, the changes will be lost. When you have finished entering the information for this template, simply click the **X** to navigate to the previous page.
## Where do I use Shift Templates?
Shift Templates can be added to a new event or added to an existing one. Click ADD SHIFT - at the top of the dropdown, add the Templates created.
This is how you can use Shift Templates through Roosted to speed up your scheduling process and save you some much-needed time! Check out our Roosted video expanding the topic to the fullest:
β
If you have any questions or want to learn about getting the best out of your Roosted - please contact a Client Success Specialist on **[support@roostedhr.com](mailto:support@roostedhr.com)** π€
# Side By Side View
Source: https://docs.roostedhr.com/guides/scheduling/side-by-side-view
Side by side explained!
The Side By Side View functions the same as the Calendar View but presents shifts in a condensed format, allowing you to see shifts for the same day or over the weekend side by side. In Side By Side View, all events from the current day onwards are visible. It shows details: the event date, name, earliest shift start time, the number of workers scheduled, and the total number of workers needed.
As shown above, the 3 events have available spots - 6/7, 8/10 & 10/23. To see multiple events, you can simply click each event and they will appear side by side:
## Creating an Event
A new event can be created by clicking the + on the top left. Enter the Event Name, Event Date & Venue.
Once done, click Next, and add a Client, Areas, Job ID, or Event Comment for Workers. Choose Finish and the event is created. Add shifts & select the skillset in Add Skillset/Shifts:
Set start time, and optional end time. Adjust the number of workers you need and alternates, or add any comments to the shift. Once done, click Create Shift.
Once the shift is created, you can add as many skillsets as you need:
**Assign** or **Invite Workers** by clicking Add Workers, and add **Preferred Workers** by clicking Open To All Workers. Set Sign-Up Bot by clicking Details on the left side - Sign Up Bot - Allow Sign-Up Bot.
From the Details page, adjust shift details or change Shift Comments by clicking **Basic Info**. Once you've reviewed and updated the info, click **Publish** to make the shift visible to workers. This allows them to see their assignments or sign up/request to work the shift. See **[Shift Publishing](https://support.roostedhr.com/en/articles/9497043-shift-publishing)** for more information.
## Actions
Under actions, there are a number of options that you can use:
* **Contact Workers** Contact all workers at this event either through Email/Text Message or both.
* **Print Timesheet** Print physical time sheets broken down by individual worker or a Master Timesheet with all workers listed.
* **Email Openings** Email workers who have the correct skillsets to fill any open shifts.
* **Copy Event** Copy this event with the same shifts to a singular day or multiple days. See **Copying Events** for more information.
* **Send Client Roster** Send your selected client a list of all workers and positions at this event.
* **Mark as ready to sync** Your workers to sync this event to their calendar through
* **Calendar Sync**
* **Delete Event** Completely delete all details of this event. - deletions are irreversible.
At the top of the event, choose Details to change event info, and add or edit the Event Comments. By clicking Custom Fields, you can edit this tab.
Add Documents by clicking DOCS.
## Filtering Options
To filter your view, click the funnel icon in the top left corner. From here, you can:
* **Select the start date** of events you want to view at the top of the page
* **Search by Event Tags**
* **Search by Event Names**
* **Search by Venue Name**
* **Filter by Areas**
* **Show only unfilled events** (i.e., events that require your attention)
Once you have set your filters, click **Apply** to update the view.
Balance out your workforce and drag and drop workers from one shift to the next. Click and hold the worker you want to move from one shift to the next shift.
Drag and drop Kyle from the shift on the 27th to the shift on the 28th.
If the new shift is already full, tool will ask if you want to increase the quantity.
If you click **Increase Quantity**, it will increase by 1. See which workers have 'Checked In' for their shift by seeing a green checkmark next to their name. Please see **[Shift Check-In Bot](https://support.roostedhr.com/en/articles/9497048-shift-check-in-bot)** for more information.
See our latest video that explains the topic in detail!
And this is Side By Side View on Roosted! π
# Spreadsheet View
Source: https://docs.roostedhr.com/guides/scheduling/spreadsheet-view
Compare even the smallest differences in the most detailed view in Roosted.
Spreadsheet View is exactly as it sounds! It provides a tabular overview of all scheduled shifts. To access it, navigate to **Scheduling - Spreadsheet View**. It shows all the details of the shift:
* **Date**
* **Event** associated with the shift
* **Venue location**
* **Skill set** required
* **Start time**
* **Scheduled worker's name**
If a position is open, where the worker's name would be, it will display **Click to fill**.
To edit the event, hover over any detail highlighted below and click. This will redirect you to the **Main Event Page**.
To view details on the workers, click on the Worker Name. This will display additional information:
* **Date** the shift was filled
* **Method** of sign-up
* **Time Punches**
* **Custom Fields**
* **Pre-Punch Questionnaire**
You also have the option to:
* **Remove** the worker from the shift by clicking **Remove**
* **Bailout** the worker by clicking **Bailout** (see "Bailouts" for more information)
If the position is open and you want to add a worker through Direct Assignment or Invite to Work, click **Click to fill**. Select the worker you wish to assign or invite and click **Add selected**.
## Spreadsheet View Filtering
Filter what information is visible on Spreadsheet View. Click Filter and change the start date, search for Event Names, Venue Names, Filter by **Areas**, **Clients**, **Event Tags**, **Skillsets** & Workers.
Click Apply to search by filters chosen.
The list can also be exported - on the left side of the screen.
β
There are two options for exporting
* Current view - will export the events visible on the screen.
* Custom view - will export the events filtered out.
Check out our latest video explaining the matter in detail:
And this is how you can use Spreadsheet View through Roosted! π
# Event Time Tracking Manager
Source: https://docs.roostedhr.com/guides/time-tracking/event-time-tracking-manager
What the Event Time Tracking Manager is and how it can be used to easily punch your workers in and out.
In this article, we will explain the role of the Event Time Tracking Manager and how to use this feature to manage time punches for your workers.
## What is an Event Time Tracking Manager?
The Event Time Tracking Manager is a trusted individual assigned to manage time punches on-site. This person does not need to be an admin but must have a Roosted account. They can handle time punches on the day of the event and the following day, including adding, editing, and deleting punches if necessary.
## Assigning an Event Time Tracking Manager
To assign an Event Time Tracking Manager:
1. Go to the **Main Event Page**.
2. Click on the **box** to add a Time Tracking Manager.
3. Type the name of the worker you want to assign and select them from the list.
This will grant the selected individual the necessary permissions to manage time punches for the event.
Click the worker name from the dropdown, they will be assigned as the time tracking manager for this event. If you want to remove this worker, click the red X.
**Managing Time Punches** On the Mobile App, the Event Time Tracking Manager can scroll to the bottom of the page & tap Manage Time Tracking. From here, they can see a list of events that they have been assigned to review and to add/view time punches for.
From this page, they can see a summary of how many workers have punched in, punched out and how many workers have no punches.
**Adding a time punch** Time punches can be added to a worker under their name and tap Add Punch.
From there, add the date and time and tap Done, followed by Submit Punch.
The submitted punch will appear as shown below.
**Editing a time punch** Time punches can be edited by tapping the blue wrench, entering the new time and tapping submit change & confirm.
**Deleting a time punch** Deleting a time punch is done simply by clicking the red trash can and confirming by clicking Delete Punch.
## Client Approval
The Event Time Tracking Manager, Admins, and Owners can receive client approval at the end of the shift. This process involves getting a signature from the client to confirm the hours and time punches.
## How to Obtain Client Approval:
1. **Ensure Client Presence**: Make sure a client is physically present to sign off on the time punches and hours worked.
2. **Initiate Approval Process**: Tap **Client Approval** in the system.
3. **Confirm Locking Time Punches**: The system will prompt you to confirm that you want to start the approval process. This action will lock all time punches for the event, preventing further modifications.
By following these steps, you can secure the clientβs approval and finalize the eventβs time-tracking details.
Once the **Show Approval Screen** has been tapped, you will be prompted to hand the device to the client. The client will then review the following on the screen:
* **List of Worker Names**: All workers who were part of the event.
* **Time Punches**: Detailed entries of each worker's punch in and out times.
* **Total Hours**: The total number of hours worked, calculated at the top of the screen.
The client can then provide their signature to approve the time punches and hours worked.
When the client is ready to sign, they should follow these steps:
1. **Click "Sign"**: This will prompt them to enter their name and add any additional comments (optional).
2. **Click "Next"**: The screen will rotate to allow the client to write their signature in the designated box.
3. **Enter Signature**: The client writes their signature into the box.
4. **Click "Submit"**: After entering their signature, the client clicks "Submit."
Once completed, the client should return the device to the Event Time Tracking Manager, Admin, or Owner.
Similarly, if you prefer a senior staff member to review and sign off at the end of an event instead of a client, and the client will not be physically present, follow these steps:
1. **Tap "Show Approval Screen"**: The Event Time Tracking Manager will initiate the process.
2. **Hand the Device to the Senior Staff Member**: Provide the device to the senior staff member for review.
3. **Review Details**: The senior staff member will review the list of worker names, time punches, and total hours calculated at the top of the screen.
4. **Click "Sign"**: The senior staff member will click "Sign," enter their name, and add any optional comments.
5. **Click "Next"**: The screen will rotate to allow the senior staff member to write their signature in the designated box.
6. **Enter Signature**: The senior staff member writes their signature.
7. **Click "Submit"**: After entering their signature, they click "Submit."
8. **Return the Device**: The senior staff member should return the device to the Event Time Tracking Manager.
This process will lock all time punches for the event and complete the approval process. And this is how the Event Time Tracking Manager can be used through Roosted! π
# Pre Punch Questionnaire
Source: https://docs.roostedhr.com/guides/time-tracking/pre-punch-questionnaire
Viewing and Editing the Pre-Punch Questionnaire
## Using the Pre-Punch Questionnaire on Roosted
In this article, we will discuss how to use the Pre-Punch Questionnaire option on Roosted.
## What is a Pre-Punch Questionnaire?
A Pre-Punch Questionnaire is used to ask questions of your workers before allowing them to punch in. This is typically used for COVID health screening or safety questions. The questionnaire can be customized to fit your needs and allows workers to submit yes/no answers.
## Example Usage
For example, if you're using it for COVID health screening, you might ask questions such as:
* Have you experienced any of the following symptoms?
* Have you tested positive for COVID-19 in the last X number of days?
If a worker answers "YES" to any of these questions, **they will be prohibited from punching in and instructed to contact HR**. The HR contact information will appear on your Company Info page.
## How It Works
Workers must answer the questionnaire correctly based on your specified requirements to be allowed to punch in. If they do not answer correctly, they will not be permitted to punch in.
## Viewing the Pre-Punch Questionnaire
You can view a worker's Pre-Punch Questionnaire in two ways:
1. **Through the Time Tracking Module:**
2. Navigate to **Time Tracking** on the blue bar on the left-hand side.
3. Select the worker whose questionnaire you want to view.
4. Click the wrench icon on the right-hand side of their punch entry.
5. Select **Pre Punch Questionnaire** to view the details.
6. **During Punch Edit:**
7. When editing a worker's punch, you will have the option to view the Pre-Punch Questionnaire responses.
This ensures that all necessary health or safety checks are completed before a worker starts their shift. **Main Event Page** On the main event page, you can easily see which workers have failed the pre-punch as shown below.
You can view the pre-punch questionnaire by clicking on the worker's name and navigating to the **Pre Punch Questionnaire**. For example, if Alex failed one of the pre-punch questions, he will not be able to punch in and will be informed to contact HR. This process helps ensure that all necessary health or safety checks are completed before a worker starts their shift.
You can view and edit the pre-punch questionnaire for a worker through the Time Tracking Module.
## Steps to Access the Pre-Punch Questionnaire
1. **Navigate to Time Tracking:**
2. On your blue bar on the left-hand side, click on **Time Tracking**.
3. **Select a Worker:**
4. Choose the worker whose punch you want to edit.
5. **Edit a Time Punch:**
6. Click the wrench icon on the right-hand side of the worker's punch entry.
7. Select **Pre Punch Questionnaire** to view or edit the questionnaire.
This process allows you to ensure accurate time tracking and address any issues with the worker's punch details.
If you wish to add or edit your existing Pre Punch Questionnaire. Please contact your Client Success Specialist or open a support ticket. Make sure to check our latest video that explains the topic:
And this is how you can use the Pre Punch Questionnaire through Roosted! π
# Reimbursements
Source: https://docs.roostedhr.com/guides/time-tracking/reimbursements
Pay back your workers for job related expenses.
Reimbursements allow you to pay workers for expenses or mileage incurred while working a shift. These can be recorded and added in two ways:
## Admins Adding Reimbursements
Admins can add reimbursements with or without a photo through the Time Tracking module. To add a reimbursement:
1. Ensure the reimbursement option is enabled.
2. Select the worker from the dropdown menu.
3. Navigate to the relevant day.
4. Click the plus icon (similar to adding a time punch).
5. Click **Add Reimbursement**.
This process helps streamline the management of reimbursements for your workers.
From here, you can add either an amount or mileage.
* **To Add an Amount**:
* Leave the Mileage toggle off.
* Enter the amount by clicking on the field to the right of the date and typing the amount.
* Optionally, add a comment and upload a receipt picture. **Uploading a receipt can be made a requirement for admins in the settings; see details later in this article.**
* **To Add Mileage**:
* Toggle on the Mileage option and enter the number of miles.
To finalize the reimbursement, simply click **ADD**.
Once the reimbursement has been added, it will like this:
Mileage is added in the same way as an amount, with a few adjustments:
* **To Add Mileage**:
* Toggle on the Mileage option.
* Enter the mileage number by clicking on the field to the right of the date and typing the mileage.
* Optionally, add a comment and upload a mileage picture or map.
Finally, click **ADD** to complete the reimbursement.
The mileage reimbursement will appear like this:
## Workers Adding Reimbursements
Depending on your configuration, workers can submit reimbursements using a desktop or mobile browser. Here's how they can do it:
1. **Navigate to the Worker Calendar**:
2. Access the Worker Calendar from the desktop or mobile browser.
3. **Add Reimbursement**:
4. Click on the current day or the previous day by scrolling down.
5. Click the **+** icon to the right of where it says **Reimbursements**.
This allows workers to easily submit their reimbursement requests for approval.
From here, a worker can submit two different types of reimbursements:
## Amount
* **Enter Amount**: The worker can enter the reimbursement amount in the Amount section to the right of the date.
* **Optional Comment**: Add a comment if desired.
* **Upload Receipt**: Optionally upload a receipt picture.
* **Submit**: Click **ADD** to submit the reimbursement.
This process allows workers to provide all necessary information for reimbursement requests efficiently.
When a worker adds a reimbursement, it will appear as shown below as Pending until approved by an admin with time tracking capabilities.
When the reimbursement is Pending, a worker can delete a submitted reimbursement by clicking the trash can on the right side.
When the reimbursement has been approved, it will appear as below.
When a reimbursement has been rejected, it will appear as below.
## Mileage
* **Toggle Mileage On**: Activate the Mileage option.
* **Enter Mileage**: Input the mileage number in the Mileage section to the right of the date.
* **Optional Comment**: Add a comment if desired.
* **Upload Mileage Picture/Map**: Optionally upload a mileage picture or map.
* **Submit**: Click **ADD** to submit the reimbursement.
This allows workers to provide all necessary details for mileage reimbursements efficiently.
## Note
Mileage reimbursements will appear as Pending, Approved, Rejected, and can be deleted in the same way as amount reimbursements.
## Admins Approving & Rejecting Reimbursements
Once a worker has submitted a reimbursement, an admin with time tracking capabilities can approve or reject these requests.
* **Viewing Reimbursements**:
* In the Time Tracking module, select a worker from the dropdown.
* A reimbursement symbol will appear next to the workerβs name, indicating they have pending, approved, or rejected reimbursements.
Admins can then review and take action on the reimbursement requests as needed.
Approving & Rejecting Pending reimbursements can simply be done by clicking the blue tick or yellow X and confirming.
Once you approve or reject the reimbursement, the Status will change from Pending to Approved or Rejected (*depending on which one you choose*).
If you have approved a reimbursement by accident, you can always reject it by clicking the yellow X to the right. Similarly, if you have rejected a reimbursement by accident and need to approve it, you can click the blue tick to the right. Doing either of these actions will change the status to Approved or Rejected, depending on your selection.
## Reimbursement Settings
You can adjust whether to use reimbursements and configure their settings by navigating to: **Configuration** -> **Settings** -> **Time Tracking** -> **Reimbursements**. Here, you can enable or customize how reimbursements are used according to your preferences. Please see **[Reimbursement Settings](https://support.roostedhr.com/en/articles/9491787-reimbursement-settings)** for more information. And this is how you can use Reimbursements through Roosted! π€
# Time Punch Settings
Source: https://docs.roostedhr.com/guides/time-tracking/time-punch-settings
Adjust your Time Punch Settings
In this article, we'll walk you through adjusting your Time Punch Settings on Roosted. To modify these settings, go to **Configuration - Settings - Time Tracking**. See **[Time Punches](https://support.roostedhr.com/en/articles/9497259-time-punches)** for more info!
## Time Punch Settings Overview
**Allow Workers to Punch In**
* This setting lets workers punch in for events. If turned off, only **[Reviewers](https://support.roostedhr.com/en/articles/9491947-event-reviewer)**, Event Time Tracking Managers, or admins can punch workers in.
**Pre-Approve Time Punches**
* This allows time punches to be automatically approved based on your configured settings, eliminating the need for manual admin approval. Time punches will be approved only if they meet the criteria you set.
**Allow Workers to Sign Off on Time Punches**
* Workers can sign off on their time punches at the end of their shift, which can help reduce complaints about hours worked.
**Custom Acknowledgment**
* Use this feature for workers to agree or acknowledge terms when punching out of a shift. For more information, see Custom Legal Acknowledgment.
**Allow Reviewer to Submit Time Punches**
* Reviewers can be permitted to punch in and out workers during their shifts.
**Ask / Require Selfie**
* You can request or mandate that workers submit a selfie when punching in or out.
**Get Location / Geo-Fencing**
* Collect workers' location data at the time of punching and enable Geo-Fencing to restrict the distance from the event location where punches can occur. For further details, see Geo-Fencing. Additionally, you can require a location with Anytime Punches; refer to Anytime Punches for more information.
**Stop Early / Late Punches**
* Configure limits for how early workers can punch in before their shift starts and how late they can punch out after their shift ends. Adjust the sliders to set these time limits.
**Maximum Normal Shift Length**
* Set the maximum duration for a normal shift, which can be adjusted just below the fiscal start of the week setting.
## Maximum Shift Time Setting
The **Maximum Shift Time** determines which time punches require Admin or Owner approval. If an Admin or Owner adds a time punch that exceeds this limit, they must select 'Override Maximum Shift Time' when inputting the worker's time punch. It's advisable to set a reasonable maximum shift time to avoid unnecessary flags. For instance, if the maximum shift time is set to 10 hours and a worker punches in at 12 PM and out at 10:01 PM, the system will flag this as exceeding the limit. If you have questions, please contact your Client Success Specialist.
## Allow Workers to Suggest Edits
If workers are permitted to submit time punches, you can further enable them to suggest edits or request deletions for past punches. This setting can be adjusted under the 'Worker Hours Display' section.
And this is how you can adjust your Time Punch Settings in Roosted! π₯³
# Time Punches
Source: https://docs.roostedhr.com/guides/time-tracking/time-punches
Track the hours worked, for better control of wages as part of Time Tracking.
Time punches are used to track the hours workers have completed, which are essential for calculating wages. **Workers:**
* Can **submit**, **view**, **edit**, and **delete** time punches through the Worker Calendar on both desktop and mobile browsers, as well as the Mobile App.
* **Note:** The ability for workers to manage time punches can be enabled or disabled based on your company settings. For details, refer to **Time Punch Settings**.
**Reviewers and Time Tracking Managers:**
* Can **submit** or **change** time punches on the day of the event and the following day using the Mobile App.
**Admins:**
* Can **add**, **edit**, or **delete** time punches using desktop, mobile browser, or the Mobile App.
## **Submitting Time Punches**
**Workers** can submit time punches in two locations:
1. **Worker Calendar**
2. Accessible via desktop or mobile browser.
3. After logging in, workers are directed to their homepage where they can click **Go to Calendar** to access their calendar.
Workers can submit time punches by following these steps:
1. **Navigate to the Calendar:**
2. Click on the current day or the previous day.
3. **Add Time Punch:**
4. Scroll down and click the **+** button to the right of the "Time Punches" section.
Select the time and click Add.
Multiple time punches will show as below on the calendar.
Time Punches will be Pending until an admin approves them through the Time Tracking Module. Once they are approved, they will appear as below.
Any Pending or Approved time punches can be edited or deleted - click the wrench on the right side, input changes and click "Submit"
Next, it will appear as Pending Change.
To delete a punch, click the wrench, Click Delete & OK. When a worker has deleted, it will appear as Pending Delete - deletions do not need to be approved.
* ***Mobile App***
1. **Access Current Shifts:**
2. From the homepage, tap **Current Shifts** to view all your active shifts.
3. **Submit a Punch-In:**
4. When it is time to clock in, tap **Submit Punch In** to record your start time.
If you have enabled the Pre-Punch Questionnaire, the worker will be prompted to answer the questions and then tap **Submit** at the bottom of the page. If a selfie is required, the worker will need to upload a photo before they can clock in. To clock out, the worker simply taps **Submit Punch Out** when they start their break or finish their shift.
Similar to punching in, if required, the worker will need to submit a picture. At the end of the shift, workers can sign off on their time punches by tapping **Sign Hours**. The system will prompt them to confirm the punch - additional time punches cannot be added after signing. Workers can add optional notes. If Custom Legal Acknowledgment is used, the worker must check the acknowledgment box before tapping **Next**.
Next step, the phone will rotate and allow the worker to sign & tap Submit. **Reviewer & Event Time Tracking Manager Adding Time Punches:** On the Mobile App, the **[Reviewer](ttps://support.roostedhr.com/en/articles/9491947-event-reviewer)** or **[Event Time Tracking Manager](https://support.roostedhr.com/en/articles/9497253-event-time-tracking-manager)** can add time punches in **Manage Time Tracking**.
From here, they can see a list of events that they have been assigned to review and to add/view time punches for.
From this page, they can view a summary showing how many workers have punched in and out, and how many workers have not yet recorded any punches.
**Adding a time punch** Time punches can be added to a worker under their name and tap Add Punch:
From there, add the date and time and tap Done, followed by Submit Punch.
The submitted punch will appear as shown below.
**Editing a time punch** Time punches can be edited by tapping the blue wrench, entering the new time and tapping submit change & confirm.
**Deleting a time punch** Deleting a time punch is done simply by clicking the red trash can and confirm by clicking Delete Punch.
## **Admins/Owners Adding Time Punches**
Admins and Owners can add time punches through both the Desktop and Mobile Browser in various locations: **On the Event**
1. **Edit the Event**: Navigate to the event you want to edit.
2. **Add Time Punches**: Click on the worker's name, then select **Add Punch** to enter or adjust time punches for that worker.
From this page, you can:
1. **Add Date**: Enter the date for the time punch (the event date is selected by default).
2. **Enter Time**: Input the time for the punch in hours and minutes, and select AM or PM.
3. **Override Max Shift Time**: If needed, you can override the default maximum shift time set in your Time Punch Settings for this entry.
You can add multiple time punches for the same worker by repeating the above steps. Additionally, you have the option to:
* **Delete a Punch**: Click the yellow X next to the punch.
* **Edit a Punch**: Click the wrench icon next to the punch.
Every worker must have an even number of time punches at the end of their shift. To quickly add time punches for multiple workers:
1. **Navigate to Time Tracking**: On the event edit page, find the first skillset.
2. **Click Time Tracking**: This option is located to the right of Shifts.
3. **Add Time Punches**: Follow the same steps as you would for individual workers to add time punches in bulk.
**Time Tracking Module** Admins with Time Tracking capabilities and Owner-level accounts can add time punches through the Time Tracking Module. For detailed instructions, see the **Time Tracking Module**. You can configure the required fields and rules for submitting time punches in the **Time Punch Settings**. For more details, see the **Time Punch Settings** guide. Check out our YouTube tutorial that explains the topic to the fullest:
And this is how you and you workers can add time punches through Roosted! π€
# Time Tracking Filters & Pending Punches
Source: https://docs.roostedhr.com/guides/time-tracking/time-tracking-filters-pending-punches
Time Tracking Filters to manage time punches and address issues
## Using Time Tracking Filters
In this article, we will explore how to use the Time Tracking Filters to manage time punches and address issues through the Time Tracking Module. **Filtering Options:** The filter feature allows you to display only those workers who have time punches or those with issues related to their time punches or reimbursements. **Applying Filters**
1. **Accessing Filters:** Click the funnel icon next to the worker dropdown menu.
2. **Filtering by Time Punches:**
3. **Show Workers with Time Punches:** Toggle the 'Time Punches' option to display only workers with recorded time punches.
4. **Filtering by Pending or Missing Punches:**
5. **Pending Time Punches:** Toggle the 'Pending' option to show workers with time punches that are awaiting approval.
6. **Missing Time Punches:** Toggle the 'Missing' option to show workers who have missing time punches.
7. **Pending Punch Changes:** Filter workers with changes to their time punches that are still pending.
8. **Pending Reimbursements:** Display workers with pending reimbursement requests.
9. **Combining Filters:** You can combine filters to show workers who have both time punches and pending or missing punches by toggling both options.
These filters will help streamline the process of reviewing and addressing time tracking issues efficiently.
In the example below, we have two workers, Allen Waters and Annabelle Niver. Their time punches are displayed as follows:
* **Allen Waters**
* **Total Punches (Tot):** Shows the total number of time punches recorded for Allen.
* **Pending Punches (Pend):** Indicates the number of time punches awaiting approval.
* **Punches Requiring Attention (Attn):** Displays the total number of punches needing further review or action.
* **Annabelle Niver**
* **Total Punches (Tot):** Displays the total number of time punches recorded for Annabelle.
* **Pending Punches (Pend):** Shows the number of time punches pending approval.
* **Punches Requiring Attention (Attn):** Indicates the total number of punches requiring attention.
These indicators help you quickly assess which workers have time punches that need to be reviewed or addressed.
## Pending Punches (Issues with Time Punches)
Punches can be pending because of any of the following:
* The worker has suggested an edit or deletion
* Uneven number of punches
* Location is incorrect at the time of punch - applies to if you are using Geo-Fencing and the worker has punched in/out from outside the geo-fencing distance you have set.
* There is a pending reimbursement from a worker.
The punch-in and punch-out times exceed the maximum normal shift time, set at 10 hours (see **[Time Punch Settings](https://support.roostedhr.com/en/articles/9497265-time-punch-settings)**). In the example below, the time punches are 11 hours apart, surpassing the maximum shift duration.
An overview of pending / missing time punches will appear on the admin & owner homepage. See the **Dashboard** for more information.
## Fixing Pending Punches
* If a worker has suggested an edit or deletion, approve this by clicking the grey box & approve.
Because the time punch shown below has been deleted, it will fix the other two time punches.
If a worker's location shows as incorrect, it can be approved by clicking the blue tick & approve.
If there are multiple incorrect location punches, you will have to approve each one.
* If there is a pending reimbursement, you can approve or reject it by clicking the blue tick or the yellow X and confirming.
If a worker's shift length exceeds the maximum normal shift time, you can adjust the Punch-Out as follows:
1. Click the wrench icon next to the time punch.
2. Select **Modify**.
3. Check the box labeled **Override Max Shift Time**.
4. Click **Submit**.
This will allow you to save time punch despite the extended shift duration.
This will fix the pending time punch and will now show as a successful IN & OUT punch.
This is how you can filter your Time Tracking Module, what pending punches are, and how you can fix them through Roosted! π
# Time Tracking Module
Source: https://docs.roostedhr.com/guides/time-tracking/time-tracking-module
Time Tracking Module and how it can streamline your pre-payroll processing.
In this article, we'll cover the Time Tracking Module and how it can streamline your pre-payroll processing. You can access the Time Tracking Module by selecting it from the blue bar on the left side of your screen. Owner-level accounts and admins with modification permissions can control access to the Time Tracking Module by adjusting admin permissions. For more details, see the **[Owner/Admin Powers](https://support.roostedhr.com/en/articles/9491890-giving-admin-and-owner-permissions)**. On the main Time Tracking page, select a date by clicking the calendar icon. This will encompass the entire payroll period according to your company's settings.
Once you have selected the date or payroll period, you can view the time punches for that period by selecting the worker from the dropdown menu.
## Time Tracking Filtering
You can utilize the Filtering function to display only workers with time punches, or to focus on workers who have missing or pending time punches.
## Adding a Note
To add a note to worker time punches:
1. Select the worker from the dropdown list.
2. Navigate to the specific day.
3. Click the **+** icon.
4. Select **Add Note** and enter your note.
You can adjust the day if needed and enter your time tracking note by clicking into the box, typing your message, and then clicking **Add** when you're finished.
Any notes that you add will appear as shown below. **Time-tracking notes** are visible only to admins (with time-tracking capabilities) and Owners. **Adding a Punch** To add a time punch:
1. Select the worker.
2. Navigate to the desired day.
3. Click **+** and then **Add Punch**.
On the following page, you can:
* Enter the date and time.
* Choose to override the maximum shift time set in your Time Tracking Settings if necessary.
* Optionally select the shift this punch is associated with.
Click **Submit** to finalize the punch entry.
When adding multiple time punches and associating them with a shift, ensure that all applicable time punches are associated with the same shift. If you have multiple punches but only one is associated with the shift, the system will display an error, as shown below.
## Adding Reimbursements
Workers can add reimbursements through their worker calendar, depending on your company settings. For more details, see **Worker Calendar**. Admins can also add reimbursements, provided this option is enabled in your settings. To add a reimbursement:
1. Select the worker from the dropdown menu.
2. Navigate to the relevant day.
3. Click the plus icon, similar to adding a time punch.
4. Choose **Add Reimbursement**.
Add either an amount or mileage:
* **For Amount**: Leave the Mileage toggle off. Enter the amount in the field next to the date by clicking and typing the amount. You can also add a comment and upload a receipt picture. (Note: If required, admins may need to upload a receipt when adding a worker reimbursement; this setting can be adjusted in your Reimbursement Settings.)
* **For Mileage**: Toggle the Mileage option on and enter the mileage details accordingly.
Once all details are entered, click **ADD** to finalize the reimbursement.
Once the reimbursement has been added, it will appear as below:
To add mileage:
1. **Toggle Mileage On**: Enable the Mileage option by toggling it on.
2. **Enter Mileage**: Input the mileage number in the field next to the date.
3. **Add Optional Comments**: Provide any additional comments if needed.
4. **Upload Mileage Documentation**: Upload a picture or map of the mileage, if required.
5. **Click ADD**: Finalize the entry by clicking **ADD**.
The mileage reimbursement will appear as shown below.
## Time Tracking Totals
Once all pending punches have been addressed, you can view the following details for each worker:
* **Daily Hour Total**: View the total hours worked per day.
* **Weekly Hour Total**: See the total hours worked each week.
* **Payroll Period Total**: Review the total hours worked for the entire payroll period (e.g., one month).
**Daily:** **Weekly:** **Full Payroll Period:**
## Exporting Time Tracking Data
From the top left side of the Time Tracking Module:
1. Click **Export**.
2. Select **All Workers** or **Singular** based on your preference.
3. By default, you can export the data to **Excel**. For a customized payroll/time tracking export, please contact your Client Success Specialist to enable and set it up on your account.
## Time Tracking Settings
To adjust your time tracking settings:
1. Navigate to **Configuration** -> **Settings** -> **Time Tracking**.
2. Here, you can set the fiscal start of the week, configure daily overtime and double time, and adjust other relevant settings.
And this is the Time Tracking Module on Roosted! π€©
# Activating a Worker
Source: https://docs.roostedhr.com/guides/workers/activating-a-worker
Activating your workers profile and making them able to work.
Activating a worker means moving them from inactive to active, allowing them to log-in, sign-up for shifts, and receive worker emails and messages. Access the worker's module and filter the workers to see only the inactivated workers: FILTER - INACTIVATED - APPLY. You can activate one or multiple workers at the same time.
## Activating One Worker
We click the wrench icon on the worker profile - MORE - ACTIVATE and confirm.
## Activating Multiple Workers
Select all or many workers in the top left corner. If you want to deselect workers, you can do this by clicking on the checkmark. Click the SELECTED WORKERS dropdown and activate all workers & ACTIVATE ALL.
And you are done! These workers will now be viewable from your activated worker's list! π
# Anytime Punches
Source: https://docs.roostedhr.com/guides/workers/anytime-punches
Flexible Time Tracking for Trusted Workers
**Anytime Punches** gives the flexibility for your workers to punch in and out at any time and from any location. This feature is particularly useful for employees who have regular, consistent schedules, such as Monday to Friday from 9 AM to 5 PM, and whom you trust to manage their own clock-in and clock-out times.
By enabling Anytime Punches, you give your team greater autonomy while ensuring accurate time tracking for those with established and dependable work hours.
## Adding Anytime Punches
Anytime Punches can be added by navigating to the **Workers Module** - **Editing a Workers Profile - Additional - Anytime Punches on.**
## Worker Punching In/Out
When a worker has Anytime Punches enabled on their profile, they will be able to punch in from their mobile app by clicking Submit Anytime Punch.
When a worker clicks, they will be informed that this punch is not associated with an event. If they are punching in for an event, they should punch in on the shift directly: by clicking Go to shifts.
When a worker punches in and out using Anytime Punches, it will appear as normal on your **[Time Tracking Module](https://support.roostedhr.com/en/articles/9497248-time-tracking-module)**.
And that's how you can use Anytime Punches through Roosted! π
# Areas
Source: https://docs.roostedhr.com/guides/workers/areas
What are areas and how are they used?
Areas can help to track and group workers by category, department, geographic region, or anything you require. They also allow you to limit what shifts workers can see, only particular areas or all of them, depending on your choice.
Please see the video expanding the topic even further:
# Availability & Time Off
Source: https://docs.roostedhr.com/guides/workers/availability-time-off
How to approve or reject Time Off requests of your workers?
Availability or Time Off can be added by the worker on their **[Worker Calendar](https://support.roostedhr.com/en/articles/9490982-worker-calendar)** or added by an admin on the **Worker Profile**.
## Using the Availability System
For each worker, their calendar can be accessed directly from their home screen. To specify times and dates of availability using the calendar, follow these steps:
1. **Choose a Date**: Select the desired date on the calendar.
2. **Add Availability**: Click on **Add Availability** to choose the available times for the selected date.
3. **Set Recurrence**: If you want the availability to repeat on the same day of the week in the future, select the **Repeating** option.
This will ensure that your availability is consistently updated and reflected in future schedules.
## Overnight or 24-hour shifts
To specify overnight or 24-hour availability, select the **overnight** option for each relevant day. This will extend the ending time by 24 hours, converting the availability into an overnight slot. For example, if you set availability from Tuesday 9 AM to 6 PM and check overnight, it will adjust to Tuesday 9 AM to Wednesday 6 PM.
For more details on how workers and admins can add time off and the available options, refer to the **[Time Off Requests](https://support.roostedhr.com/en/articles/9497290-time-off-requests)** section.
**Availability Can Limit**:
* **Shift Visibility**: Determines which shifts your workers can see.
* **Shift Signup and Requests**: Affects which shifts your workers can sign up for or request.
* **Sign-Up Bot Messages**: Influences when workers receive notifications from the Sign-Up Bot.
You can also adjust your settings for **Availability & Time Off** to manage these aspects effectively. Please see **[Availability & Time Off Settings](https://support.roostedhr.com/en/articles/9491463-availability-time-off-settings)** for more information!
Using Availability is an advanced setting on your account. Please contact a Client Success Specialist if you are considering using this option.
# Editing a Worker Profile
Source: https://docs.roostedhr.com/guides/workers/editing-a-worker-profile
Workers module and editing the profile of the worker from the admin's view.
In this article, we will explain how to edit the worker profile through the **Workers Module**. This section is in the Admin's bar - Workers. To edit a profile, click the wrench on the right side of the worker. There you can assign skillsets, and areas as well as view the details.
## Star Ratings
There are a number of points that create this rating. See [Star Ratings](../reviews/star-ratings) & [Event Reviews & Feedback](../reviews/event-reviews-feedback) for more information.
## Worker Info
Details - Additional - Skillsets - Documents
### Details
Basic information about the worker - name, email, phone, address and photo.
### Additional
Extra details, like the birth date, and custom fields you have created on your account for the worker. **Anytime Punches** can be enabled, **Areas** and **Tags** can be set.
### Skillsets
Add or delete skillsets, see a breakdown of worker performance in each skillset they have been assigned.
Add skillsets to the worker by typing the name in the section.
To delete, click the X on the skillset name.
If you delete a worker's skillset, they will no longer be able to see future shifts with that skillset. Existing shifts with that skillset will not be affected.
## Documents
Documents on the worker profile - upload, view, or send a document signing request in a few clicks.
Click or drag a document to be uploaded to the worker's documents. On the left, already uploaded documents are visible. Choose if the document is visible to a worker.
If you make these documents viewable, workers will be able to view and download them to their devices. Documents can also be deleted - choose the bin icon on the right.
### How do workers see the documents?
**Desktop:** Profile icon in the top right - View/Edit Profile and navigate to documents.
**Mobile App:** Tap the hamburger icon on the left side - About Me - scroll; to the bottom - the documents will show under "profile documents".
See the following articles for additional information:
* [Workers Profile - Desktop](./worker-profile-desktop)
* [Workers Profile - Mobile App](./worker-profile-mobile-app)
## Limits
Limit the number of hours or shifts a worker can be scheduled for before needing an admins override. They can be added or edited in the view shown below. Please see [Shift Limits](../scheduling/shift-limits) for more information.
## Document Signing
Ask your workers to sign documents. Adding a signature from HR if necessary is also possible. Please see [Document Uploading](../documents/document-uploading) & [Document Signing](../documents/document-signing) for more information.
## Logs/Stats
Notes/Actions - Text Messages - Notifications - Stats
### Notes/Actions
A log of Text Messages and Push notifications sent out and received from a worker - all the actions taken on the account, documents, admin or owner status, and the account inactivation.
### Text Messages
Messages sent to and received from the worker.
### Notifications
A list of all push notifications sent to the worker.
### Stats
A breakdown of Shifts Worked, Bailouts, Lates & No Shows and provide a percentage breakdown below. Lates & No Shows can be added to a shift by the Reviewer or an admin.
## Schedule
Past Shifts - Future Shifts - Availability/Time Off
### Past Shifts
Shifts that a worker has completed,
View, adjust, or leave a 1-5 star review, comments or mark this worker as Late or No Show. See [Event Reviews & Feedback](../reviews/event-reviews-feedback) for more information.
### Future Shifts
Shifts that are upcoming for the worker
Shifts assigned to or sign-up by the worker. Here you can Remove or Bailout a worker from the shift. The bailout should be used if the worker is contacting you to be removed from the shift.
### Availability/Time Off
Availability and time off for a worker. Select the current day or future date and submit the Time Off or Availability for the worker.
To submit time off, click the + time off, fill up the details and click Add.
To add availability, click the + Availability, put date and time manually or choose:
* *All Day* - the whole date.
* *Overnight* - the current day and throughout the night.
* *Repeating* - this will add this availability to all the following days - if Thursday, Dec 2nd from 9 am - 5 pm & will be set available / Repeating - this availability will apply to all following Thursdays.
## Wages
Set wages for a particular worker - for example, if all the waiters earn \$15 per hour, but you have a worker who is senior and earns \$20 per hour, add the wage on their profile.
Click the Skillset to add/change the wage.
When you enter a new wage, it will show as below:
## Admin
Permissions - from this section, the worker can be made an admin/owner. See [Giving Admin & Owner Powers](./giving-admin-and-owner-permissions) for more information. Edit worker - check additional options in the "More" button: owner status, admin status, account status or updating password.
### Changing Owner Status
If a worker is an Admin, they can be changed into an owner by clicking MAKE OWNER - all permission will be granted.
**Only existing Owners can upgrade Admins to Owners** - after making an admin an owner they cannot be degraded - a support ticket will need to be opened.
### Changing Admin Status
An admin can be degraded back to worker status by clicking REMOVE ADMIN - OK. *Changing Activation Status (Active / Inactive / Pending):*
Workers can be inactivated by clicking INACTIVATE - OK - this will block the worker's access to Roosted.
Worker can be reactivated - profile - wrench - MORE - ACTIVATE - OK
**Pending workers** - those who have signed up for your company through [Worker Self Sign-Up](./worker-self-sign-up) and need to be approved (Activated) by an Admin. Click the wrench on their profile - MORE - APPROVE - OK
Workers can be filtered by status PENDING, INACTIVATED & ACTIVATED. See [Workers Module - Filters](./worker-module-filters) for more information.
If a worker is having trouble logging in, reset their password by clicking NEW PASSWORD. Set the new password and share it with the worker. If your worker has multiple accounts, with different companies, it will be necessary to reset or set the new password reset will be needed from the login page. **Resetting the password from the "workers" view won't be possible.**
For further details please refer to the separate article, which can be found here: **reset password help article.**
And this is how you can edit the worker profile through Roosted! π
# Giving Admin and Owner permissions
Source: https://docs.roostedhr.com/guides/workers/giving-admin-and-owner-permissions
How to give some of your workers more power in the app?
Any account on Roosted can be promoted to admin or owner level. Owner accounts have all permissions enabled and cannot have their permissions altered by other admins. To promote a worker to admin:
1. Go to the Workers module.
2. Click the wrench icon next to the worker you want to promote.
3. Select the **MORE** button.
4. Click **MAKE ADMIN**, then confirm by clicking **OK**.
Once you make a worker an Admin, an extra Permissions section will appear on the worker profile.
From here, an owner-level account can manage the permissions and promote worker. There are four specific permissions that can only be assigned by an owner-level account:
## Sign-Up Bot Release
This permission allows the admin to enable the Sign-Up Bot to fill shifts when it's in 'Semi-Automatic' mode. For more details, see the **[Sign-Up Bot - Settings](https://support.roostedhr.com/en/articles/9491520-sign-up-bot-settings).** If this setting is enabled, the worker will only be able to see the Sign-Up Bot but won't be able to use it if it's restricted by system settings.
## Modify Permissions
* **When toggled off:** The admin cannot alter any permissions granted to workers by an owner-level account or admins with modified permissions. They also cannot promote workers to the admin level. If they attempt to change permissions, a red error message will appear in the top right corner.
* **When toggled on:** The admin can modify permissions granted to other admins and promote workers to the admin level.
Admins cannot modify permissions granted by an owner-level account.
### View/Edit Wages
* **When toggled off:** The admin cannot view or edit the Wages section on worker profiles.
* **When toggled on:** the Wages section on the worker profile will be visible to this admin and they will be able to view and edit wages for workers and other admins.
### Manage Time Tracking
* **When toggled off:** the admin will not be able to see the Time Tracking Module on their admin bar.
* **When toggled on:** the admin will view the Time Tracking Module & make changes to time punches.
See the [Time Tracking Module](https://support.roostedhr.com/en/articles/9497248-time-tracking-module) for more information.
## To demote an account from admin to worker
1. **Go to the Workers Module:**
2. Locate the worker you want to demote.
3. **Access the Options Menu:**
4. Click the wrench icon on the right-hand side of the worker's name.
5. **Select the Appropriate Action:**
6. Click the **MORE** button.
7. **Demote the Account:**
8. Click **REMOVE ADMIN** and confirm by clicking **OK**.
## To promote an account from admin to owner
1. **Go to the Workers Module:**
2. Locate the admin you want to promote.
3. **Access the Options Menu:**
4. Click the wrench icon on the right-hand side of the admin's name.
5. **Select the Appropriate Action:**
6. Click **MORE**.
7. **Promote the Account:**
8. Click **MAKE OWNER** and confirm by clicking **OK**.
## Demoting an Account from Owner
Owners have unrestricted authority and cannot have their permissions revoked directly. This restriction is in place for security reasons.
To demote an account from the owner:
1. **Open a Support Ticket:** Submit a request through Roostedβs support system.
2. **Specify Your Request:** Clearly state your need to demote an account from owner status.
3. **Await Confirmation:** Roostedβs support team will assist with processing your request.
# Importing Workers
Source: https://docs.roostedhr.com/guides/workers/importing-workers
How to import your workers file directly to your Roosted account?
There are 3 ways to get your workers started in Roosted.
1. [Manually creating workers](https://support.roostedhr.com/en/articles/9491830-creating-new-workers)
2. [Importing workers](./importing-workers#what-is-workers-import)
3. [Worker self sign-up](https://support.roostedhr.com/en/articles/9491843-worker-self-sign-up)
In this article, we will explain how to **import workers** into your Roosted account.
## What is workers import?
This allows an admin to add multiple workers at once through an import tool. Commonly used for the first or a big batch of workers.
## Where to find it?
In the Workers module choose the "Import" button.
### Import process
Clicking the "Import" button, to start importing your workers. We recommend our standard worker import template, downloadable from the worker import wizard. You can also use your own Excel sheet of workers. See **[Worker Import Template](https://support.roostedhr.com/en/articles/9491839-worker-import-template)** for more information.
Once you add file for import, Roosted will ask you to match the columns with our columns quickly and easily. Many of the columns may already be matching.
Ensure that you scroll through all columns when the screen above is displayed.
If you have workers on your account, either active or inactive, and include them on your import sheet, the system may detect duplicate email addresses, causing these workers **to not upload correctly.**
## How long does it take to import?
Importing is very quick and usually only takes a couple of minutes, even for large imports. Once you have imported your workers, you will need to send an onboarding message to them to allow them to get logged in for the first time.
Please refresh your webpage after completing the import.
See **[Onboarding Workers](https://support.roostedhr.com/en/articles/9491914-onboarding-workers)** for more information. Check our video which explains the process even better!
And that's how you import your workers on Roosted! π
# Inactivating a Worker
Source: https://docs.roostedhr.com/guides/workers/inactivating-a-worker
How to inactivate your worker you don't want to offer shifts to anymore?
Inactivating a worker from Roosted account means that a worker will not be able to log in, sign-up for shifts, receive communications, and will not count against your active worker totals. Removing or inactivating a worker is very easy and can be done from the Workers Module. We can inactivate one worker or inactivate multiple workers at once.
An owners account cannot be inactivated.
If a worker has shifts they are currently scheduled for, Roosted will remove
the worker from those shifts.
## Inactivating One Worker
Click the wrench icon to the right of the worker profile - MORE - INACTIVATE - Inactive again to confirm.
## Inactivating Multiple Workers
Click on the check box to the top left of the workers in question - X selected workers - Inactivate Workers -> Inactivate All
If you are inactivating one or multiple workers, you will have the option to send a message via e-mail/text message or both.
Inactivating a worker doesn't mean their profile and details are lost - they can be easily **activated** again. Inactivated workers can be found using the filter function.
Please contact support for more information.
# Manually Creating New Workers
Source: https://docs.roostedhr.com/guides/workers/manually-creating-new-workers
How do you create new workers manually?
In this article, we will explain how to create workers manually. There are 3 ways to get your workers in Roosted.
1. [Manually creating workers](./manually-creating-new-workers#manual-workersβ-creation)
2. [Importing workers](https://support.roostedhr.com/en/articles/9491834-importing-workers)
3. [Worker self sign-up](https://support.roostedhr.com/en/articles/9491843-worker-self-sign-up)
## Manual Workers' Creation
Enter "Workers" from the Admin's tab. Choose Create Worker in the top left corner.
### Basic Info
Enter basic info about the worker: name, email, phone, and country.
### Additional Info
Customize optional additional info: birth date and address.
### Custom Fields
Next, custom fields (if you have them created on your account). These can be used to filter and categorize workers.
### Skillsets & Area
Assign them to your new worker:
#### Assigning Skillset
Click the Skillset dropdown and select one or multiple skillsets.
#### Adding Areas
**Areas** are an advanced feature for separating large geographical areas.
Click the **Areas** box, and a list set on your account will appear to be added to the profile. Click Finish - the new worker will receive an email with an assigned password to use when logging in.
And that's how you manually create a worker in Roosted! π
# Onboarding Workers
Source: https://docs.roostedhr.com/guides/workers/onboarding-workers
How to onboard your imported workers?
Onboarding is to get your workers logged in for the first time!
Make sure you have turned **Silence/Testing mode** off so the communication will be sent. Silence/testing mode is Configuration -> Settings -> Worker Communication -> Scroll to Silence/Testing Mode. From here you can turn it off and on.
## Onboarding Process
Go to the "Workers" section to see everyone - the yellow icon next to the picture will show if the worker has been onboarded or not - hover at it to see the details.
You can select single, multiple, or all workers.
Next, click X selected workers and Onboard workers from the dropdown.
A pop-up window with the process explained will appear, and it will show the option to include text messages (*it is recommended to use text messages as some workers may not always check their emails*).
Next, the Email/Text page will show, where editing of the information sent to the workers can be done. The pre-written message includes information on how the worker can access their account, download the Roosted App, password, and login information among others.
By scrolling down on this box, you can set a password for all workers for the first time login. Later they will be automatically asked to change their password.
Click on "Text" to create a text message to send to workers. For those who did not log in, the link and message can be resent by repeating the onboarding steps with the worker selected. By sending a text message, it will automatically ask workers who do not have emails to add their email addresses. This process includes a worker receiving a link - when clicked it will redirect them to a screen to add the email address. After it is added, the email will be sent out.
When you are happy with how you have formatted the Email & Text, click Send and you will see the success message appear.
Please check out our YouTube video on onboarding, where even more details can be found!
And that is how you onboard workers through Roosted!
# Worker Import Template
Source: https://docs.roostedhr.com/guides/workers/worker-import-template
How to use the Worker Import Template
In this article, we will explain how to use the worker import template.
## Importing Workers
Open the Import Template, and fill in the following columns:
* **Name (*Required*) -** Name of the worker & how the name appears on account
* **Phone (*Recommended*) -** number of the worker used for the worker's communication.
* **Email (*Recommended*) -** Email address of the worker used by the system to communicate with workers - first-time login information and system manual.
The contact number & email are optional, **but it is recommended to fill them.** One of them will be required for the import to be successful.
* **Address, City, Zip/Postal Code (*Optional*) -** The next 3 columns are the home address: street address, city & zip/postal code.
* **Star Ranking 1-5 (*Optional*) -** a star rating from 1-5 can be added if you want certain workers to start with a higher rating. You can leave the star ranking column blank. If you do so, each worker will start with a 2-star ranking as standard.
* **Comments (*Optional*)** - This section can be used for internal HR comments on a worker. This will appear on the Worker Profile under *Logs/Stats -> Notes/Actions*.
* **Skillset & Skillset Pay (*Optional*) -** In the next 2 columns, enter a Skillset (*position that this worker is skilled to fill*) and Skillset Pay (*wage for this position if it is specific to this worker and different from the default wage set for this skillset*). See **[Skillsets](https://support.roostedhr.com/en/articles/9491123-skillsets)** for more information. Skillsets do not need to be created on your account before uploading this template, can be created upon uploading it. There are 5 sections for each: Skillset & Skillset Pay (**10 in total**). If you need additional fields for Skillset & Skillset Pay, you can continue to add additional fields for more Skillet & Skillset Pay.
* **Tag #1 & Tag #2 (*Optional*) -** Tags are used to filter and organize workers when you are scheduling shifts. Tags do not need to be created on your account before uploading this template, can be created upon uploading it. Additional tags can be added by inserting additional columns after. (*i.e Tag #3, Tag #4 etc*). See **[Worker Tags](https://support.roostedhr.com/en/articles/9491861-worker-tags)** for more information.
* **Custom Field -** Custom Fields can be used to track additional information, not yet on the worker's profile. Custom Fields **must be created on your account before uploading this template.** Additional Custom Fields can be added by inserting additional columns after. (*i.e Custom Field #3, Custom Field #4 etc*). If uploading a Date Custom Field - please ensure you use the following format (*Using January 26th 2022 as an example):*
**26/01/2022 (Day/Month/Year)** **2022-01-26 (Year-Month-Day)** The uploading of files are part of these Custom Fields are not supported through the Worker Import Template. See **[Custom Field](https://support.roostedhr.com/en/articles/9491142-custom-fields)s** for more information.
* **Areas (*Optional*)** used by companies that cover multiple states or large geographical areas. It is a way to filter what workers can be scheduled for shifts/events. See **[Areas](https://support.roostedhr.com/en/articles/9491866-areas)** for more information. **Areas must be added to your account before uploading this template.**
Please contact your Client Success Specialist if you require areas to be added to your account.
Please ensure that you follow the template exactly as shown. Without following this template, it may give errors upon uploading.
And this is how you can use the Worker Import Template on Roosted π
# Worker Module - Filters
Source: https://docs.roostedhr.com/guides/workers/worker-module-filters
How to filter your workers foe easier search?
This article will explain how to filter workers by activation status and/or areas through the **[Workers Module](https://support.roostedhr.com/en/articles/9491823-workers-module)**.
Along the top of the Workers module, click Filter.
## Activation Status
To filter workers by status, click the dropdown and select from the following options:
* **ACTIVATED**
* **INACTIVATED**
* **PENDING**
* **WAITING ON ACKNOWLEDGEMENT**
* **ALL**
Then click **APPLY**.
For information on how to activate or inactivate workers, refer to the sections below.
## Activating Worker
## Inactivating Worker
## Areas
To filter workers by area, click **Areas** and select from the box that appears on the screen.
If we only wanted to see workers from Orange County & San Diego, click the box to the left side of these locations and click SET AREAS.
Once you have set the areas, click APPLY at the top right of the page.
All workers that have either Orange County or San Diego listed on their worker profiles will appear.
## Worker Skillset
You can filter to show workers that have one or more of the selected skillsets.
In the example above, when you click APPLY, this will show all workers that have either AV Tech, General Crew or Hand skillsets.
## Dates
To filter workers by dates, you can specify criteria such as when they were created, their next shift date, or any custom date fields. You can filter by options like 'is after', 'is on', or 'is before'. For example, to find workers created after August 1, 2022, and whose next shift is before September 20, 2022, set your filters accordingly.
## Custom Fields
As mentioned, you can filter workers using date Custom Fields, as well as Dropdown, Single Line, and Multi Line Text Custom Fields.
For Dropdown Custom Fields, you can filter by 'is' or 'is not'.
For Single Line and Multi Line Text Custom Fields, you filter by 'contains'.
For example, to find workers with Facial Hair set to 'No' and an Hourly Wage containing '17', apply these filters to narrow down your results.
Please remember when selecting filtering requirements, click APPLY to filter by your selections.
And that is how you can filter your workers by Activation Status and/or Areas through the Workers module on Roosted! π
# Worker Profile - Desktop
Source: https://docs.roostedhr.com/guides/workers/worker-profile-desktop
Viewing and editing your personal profile on the Desktop & Mobile Browser.
Anyone with a Roosted account can view and edit their profile using the Desktop, Mobile Browser, and Mobile App. In this article, weβll focus on how to view and edit your personal profile using the Desktop and Mobile Browser. See [Worker Profile - Mobile App](https://support.roostedhr.com/en/articles/9491905-worker-profile-mobile-app) for information on how to do this through the Mobile App.
When you log into either of the above, from the main homepage, you can click the person icon in the top right corner & click View/Edit Profile.
## Details
Here you can edit the basic information or upload a picture.
The worker can reset their password by clicking New password - entering a new password and clicking OK.
## Additional
When navigating to the **Additional** section, you can enter extra information such as your birth date and details for any Custom Fields that have been made Worker Editable. For more information, refer to the section on [**Custom Fields.**](https://support.roostedhr.com/en/articles/9491142-custom-fields) If a Custom Field is Worker Editable, you can:
* **Click** on the field to enter details.
* For a **Date Field** (e.g., License Expiration), click the calendar icon to the right of the field and select the Day, Month, and Year.
If there is a Dropdown menu, you can click the arrow down and select from the dropdown.
If the Custom Field is a **File Field**, you can either click to upload or drag and drop the document. This file will also appear under documents in the Worker Profile. To view or manage the document:
1. Navigate to **Worker**.
2. **Edit the Worker Profile**.
3. Go to **Worker Profile** and select **Documents**.
Please see **[Editing a Worker Profile](https://support.roostedhr.com/en/articles/9491851-editing-a-worker-profile)** for more information.
When a worker uploads a file, an admin account can decide whether this is worker-viewable or not.
## Calendar Sync (*Worker & Admin Calendar*)
You can sync your Roosted Calendar to display both past shifts and the next three months of shifts. To do this:
1. **Click** "Click to Sync Calendar" to start the syncing process.
2. **Copy the Link:** You can also copy the provided link and paste it into a web browser to connect the calendar.
Additionally, detailed syncing instructions are available for both Apple and Google calendars:
* **[Apple Instructions](https://www.youtube.com/watch?v=lt27ioncNy4)**: Click to view a walkthrough for syncing with Apple Calendar.
* **[Google Instruction](https://www.youtube.com/watch?v=lt27ioncNy4)s**: Click to view a walkthrough for syncing with Google Calendar.
As an admin, you can sync all past and next 3 months of events. Instructions for syncing this calendar are the same as syncing a worker calendar.
## Documents
On your worker profile, you can see documents that have been made worker-viewable. Please see [Documents](https://support.roostedhr.com/en/articles/9497238-document-signing) for more information.
Admin & Owner level accounts has the ability to lock certain worker information and prohibit workers from updating this information without contacting an Admin.
And that is how you update your profile on the desktop or mobile browser through Roosted! π
# Worker Profile - Mobile App
Source: https://docs.roostedhr.com/guides/workers/worker-profile-mobile-app
Viewing and editing your personal profile on the Mobile App
Anyone with a Roosted account can view and edit their profile using the Desktop, Mobile Browser, and Mobile App. In this article, weβll focus on how to view and edit your personal profile using the Mobile App. Please see **[Worker Profile - Desktop](https://support.roostedhr.com/en/articles/9491918-worker-profile-desktop)** for information on how to do this through a desktop or mobile browser.
Log in to the Mobile App, and click the hamburger icon on the left side.
From here, you can click About Me.
There, you can change your password by tapping Change Password, enter a new password and tapping OK. Depending on company settings, the company will also be able to change or upload a photo and enter their basic details.
You can also enter or edit **[Custom Fields](https://support.roostedhr.com/en/articles/9491142-custom-fields)** if they are Worker Editable.
At the bottom of the Worker Profile on the Mobile App, you can view any documents that are accessible/visible to you.
And this is how you can edit your profile through the Mobile App on Roosted! π
# Worker Self Sign-up
Source: https://docs.roostedhr.com/guides/workers/worker-self-sign-up
How your workers can register to work with you through Roosted?
There are 3 ways to get your workers started in Roosted.
1. [Manually creating workers](https://support.roostedhr.com/en/articles/9491830-creating-new-workers)
2. [Importing workers](https://support.roostedhr.com/en/articles/9491834-importing-workers)
3. [Worker self sign-up](./worker-self-sign-up#what-is-it)
In this article, we will explain Worker Self Sign-Up, where workers can sign-up to be a worker for your company.
## What is it?
Exactly as it sounds - workers can sign-up as a worker for your company through your company's login page.
By clicking Sign up, the worker will redirected to enter personal details: name, email address, contact number, and set up a password. Once the worker has filled in the information, they can then click submit.
When the worker has signed up, they will receive a message that their account needs to be approved by a manager.
This worker's account will appear in the workers module under "pending workers". Here's how it looks from an admin perspective:
1. Go to the workers module located on the blue admin bar on the left-hand side
2. Click "Workers"
3. Click "Filter"
4. Select "PENDING" from the dropdown
5. Click "APPLY.
You will then see the worker who has signed up.
## Approving a Pending Worker
Approving a pending worker click the wrench to the right side - MORE - APPROVE - OK
When you have completed this process, the worker will then move from PENDING to ACTIVATED.
This is how workers can sign-up to your company using the Worker Self Sign-Up! π
# Worker Tags
Source: https://docs.roostedhr.com/guides/workers/worker-tags
What is the purpose of tags and how to use them?
In this article, we will explain what worker tags are and how this can be used when scheduling and filling shifts.
Worker tags are used to filter and organize your workers - many companies like to use them for different teams (i.e A-Team, B-Team) or different worker skills (i.e Can drive truck, Can speak Spanish)
## How do you add worker tags?
Worker tags can be added by **Editing a worker's profile** in the **Workers Module** - the wrench to the right side - **Additional**.
Add tags to the worker profile to filter workers when adding them to a shift.
## Using Worker Tags to Fill Shifts
### Default Client Rules & Tags
Add rules & tags to a Client - when creating an event for that client, those will apply automatically. Add these to a client's profile by navigating to Client - Clients - the wrench - Default rules & tags.
If you need your events tags to be deleted or modified (*i.e. updating a misspelled tag*), please contact your Client Success Specialist or open a support ticket.
See [Rules](https://support.roostedhr.com/en/articles/9497157-rules) and [Clients](https://support.roostedhr.com/en/articles/9497330-clients) for more information on using Worker Tags. Please see our video to dive into the topic even more!
And that's how you use Workers Tags in Roosted! π
# Worker Transfers
Source: https://docs.roostedhr.com/guides/workers/worker-transfers
How to transfer workers?
Worker Transfers are workers who have been hired through an ATS (Applicant Tracking System) such as JazzHR or SmartRecruiters.
To view a full list of available HR integrations, navigate to **Configuration - Integrations**. From this page, click **ADD - Applicant Tracking System** and the list will appear for you to browse.
If you use an Applicant Tracking System that is not listed, please contact your Client Success Specialist or open a support ticket.
For more information on adding integrations, please see **[Integrations](https://support.roostedhr.com/en/articles/9491216-integrations)**. Once you have an ATS connected, workers who have applied and been hired will appear as a **PENDING WORKER TRANSFER**.
Admin/Owner accounts can view **PENDING WORKER TRANSFERS** from their Dashboard.
You will also be able to see the position this person has been hired for, which ATS they applied from (e.g., JazzHR), and their application date (e.g., January 2nd, 2022). **Confirming a Worker Transfer** To confirm a worker transfer, click the **+** symbol.
When you click this, you will be prompted to add the worker profile. This allows you to view all details about the worker, input information for Custom Fields, and add Skillsets and Areas for this worker.
Once everything looks good, click Finish - OK. This worker will now be activated on your account! **Rejecting a Worker Transfer** To reject a worker transfer, click the trash can icon on the right side of the worker transfer.
Once you click this, it will prompt you the confirm the rejection by clicking Reject. Once you do this, this worker transfer will disappear from this list!
And that is how Worker Transfer work through Roosted! π
# Workers Module
Source: https://docs.roostedhr.com/guides/workers/workers-module
Create, view, and sort your staff.
The Workers module is where you can create, view, and sort your staff. From here, you can also assign skillsets to specific workers. The Workers module can be found in the admin bar on the left side - Workers.
## **Creating workers**
There are 3 ways that workers can be created. Please click the links below for more information.
1. **[Manually creating workers](https://support.roostedhr.com/en/articles/9491830-creating-new-workers)**
2. **[Importing workers](https://support.roostedhr.com/en/articles/9491834-importing-workers)**
3. **[Worker self sign-up](https://support.roostedhr.com/en/articles/9491843-worker-self-sign-up)**
## Main Workers Page
At the top of the worker's page, there are several options. You can CREATE WORKER - which is the process of **[manually creating workers.](https://support.roostedhr.com/en/articles/9491830-creating-new-workers)**
You can search for Worker Info and Skillsets - if you want to find workers with the Supervisor skillset, click the search box and type "Supervisor." This will display workers who have the Supervisor skillset.
### Filter
You can click Filter, which will allow you to filter workers by activation status or Areas. See **[Worker Module - Filters](https://support.roostedhr.com/en/articles/9491828-worker-module-filters)** for more information.
### Import
By clicking IMPORT, this will allow you to begin the process of **[importing workers.](https://support.roostedhr.com/en/articles/9491834-importing-workers)**
### Worker Module Sorting Options
Just above the worker list, you'll find various options for sorting and viewing information. By default, the workers are sorted by name. You can change the sorting criteria by clicking on the sortable boxes along the top of the page.
#### ADMIN
Sort workers by ADMIN - accounts that have ADMIN or OWNER level will show and be indicated with the following symbols.
#### RATING
Workers can be sorted by their star rating, ranging from 1 to 5. Click the RATING box to sort in ascending or descending order.
#### STATUS
Workers can be sorted by their activation status.
#### LAST LOGIN
Sort workers by the most recent time they logged into their Roosted account.
#### LAST SHIFT, NEXT SHIFT and TOTAL SHIFTS
You can sort workers by the date of their last shift, the date of their next shift, or the total number of shifts they have been scheduled for. Note that shifts marked as "NO SHOW" still count towards their total shifts. You can review shift statistics when editing the worker's profile.
#### CREATED
Sort workers by the date their account was created.
## Editing A Worker
You can easily edit a worker's profile information, make a worker active or inactive, make a worker an admin or owner, and set a new password. See **[Editing a worker profile](https://support.roostedhr.com/en/articles/9491851-editing-a-worker-profile)** for more information.
## Exporting Worker Information
You can now export worker information directly from the Workers Module. To do this, select multiple workers by clicking the checkbox at the top left of their profiles.
You can also select all workers by clicking the box at the top left of the page.
When you have selected multiple or all workers, you will see a box that informs you how many workers have been selected and from here you can click to expand the dropdown option.
Clicking **Export Workers** will download the information for the selected workers as an Excel file, allowing you to analyze and manipulate the data as needed.
And this is the Workers Module on Roosted!
Please contact your Client Support Specialist if you have any questions or want to know how to get the best out of your Roosted account! π
# Direct Shift Assignment
Source: https://docs.roostedhr.com/guides/workflows/direct-shift-assignment
How to directly assign workers to your shifts?
In this article, we will explain how you add workers directly to open shifts. When you are on the **[Main Event Page](../scheduling/main-event-page)**, when viewing open slots, choose '*Click To Fill*' button. It will show how many workers are available to fill this position.
On the next page, select the workers you would like to fill this position with by clicking on them. You can select multiple workers if you have more than 1 open spot.
If using **[Shift Limits](https://support.roostedhr.com/en/articles/9497168-shift-limits)**, you will be able to see how many hours/shifts each worker has been scheduled for including any hours/shifts as an alternate and if they will exceed that limit, it will appear as shown below.
As an admin, you can override and schedule a worker even if it exceeds their limit. You will also see a complete list of workers with the required skillset for open shifts. If a worker is already booked on another shift or has a time-off conflict, their name will appear in pink with a symbol next to it. Admins with scheduling editing capabilities and Owner-level accounts can override these conflicts and 'double-book' workers if necessary.
Once you have selected the worker to fill the open position, click **"Add Selected"** to assign them to the shift.
Once you have done this, the worker will appear in the previous open slot like shown below.
If the shift has been published, the worker will receive an email, push notification/text to say that they have been added to this shift, and if the shift is not yet published, they will receive the notification when you click publish.
See **[Shift Publishing](https://support.roostedhr.com/en/articles/9497043-shift-publishing)** for more information.
Make sure to check out our YouTube video explaining the topic fully!
And this is how you can manually assign workers to open positions in Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π₯³
# Invite to work
Source: https://docs.roostedhr.com/guides/workflows/invite-to-work
How to use invite to work feature?
The **Invite to Work** feature allows you to offer shifts to workers even if you're unsure of their availability. This feature sends an invitation that the worker can either accept or decline.
## How Does It Work?
Notifications can be sent via text message and/or email, allowing a worker to accept or reject the invite. If the worker rejects the invite or the invite expires, the opening will become available to other workers.
## How Do You Send an Invite?
To send an invite, go to the event page and click on the grey box labeled "Click to Fill" in an open shift spot.
Click on the worker that you want to fill this particular shift and invite them to work.
When the setting is toggled off, the invite duration is not adjustable. However, when you toggle this setting on, a sliding scale will appear. You can drag the slider to set how long you want the invite to last before it expires. The slider will look like the image below.
Once you have decided on a timeframe (2 days in the example above), click DONE. A confirmation will appear, detailing that the worker has been invited and given 2 days to accept or decline before the invite expires. When you are satisfied with this, click ADD SELECTED.
When you click ADD SELECTED, you will be brought back to the main event page. Here, you will see that the worker is marked as Pending Invite, indicated by the grey envelope icon.
If the worker does not reply within the timeframe you have set, their invite will expire and they will automatically be removed from the shift.
If you need a longer invite period than your current maximum, you can contact your Client Success Specialist or open a support ticket to adjust the limit.
You can adjust your Invite to Work settings. See **[Invite to Work - Settings](https://support.roostedhr.com/en/articles/9491776-invite-to-work-settings)** for more information.
Check out or latest Roosted video that expands the topic fully:
And this is how you use Invite to Work through Roosted π
# Preferred & Banned Workers
Source: https://docs.roostedhr.com/guides/workflows/preferred-banned-workers
How to set up workers that are preferred to work with your customers?
## What are preferred workers?
*Preferred workers* allow you to open a shift signup to *only* the workers of your choice.
## How to use preferred workers?
From the event edit page, when you are filling shifts click "No preferred workers"
Next, Select a Workers who have the matching skillset to work this shift. You will see a list of workers with availability for the shift.
You can also see workers already booked on another shift.
Once you choose workers that you would like to work this shift, select an expiry date on this offer by toggling "Expires?" on.
When you toggle expiry on, set an expiry date and time on this offer to workers.
Click Save Selection:
Once the shift is published, workers will receive a notification with the shift details. It will also appear in their available shifts. After the initial notification period expires, all workers with the relevant skill set will be able to sign up or request the shift, depending on your company settings.
## Setting Preferred & Banned Workers
1. Manually adding (*applicable for preferred workers only*) - as explained above
2. Through the **Clients** page.
3. Accepting clients' feedback submitted through the **Client Portal**.
**Through the Clients page** *(Admin bar - Clients - Clients)*:
* Click the wrench on the right and enter the Workers section.
* Drag and drop workers into the preferred or banned section.
Owners and Admins can drag and drop workers to and from the Preferred or Banned list.
* **Preferred workers** are those who work well with the client and perform exceptionally.
* **Banned workers** are those who do not work well with the client or had a negative experience, and you do not want to assign them to future events for that client.
**Accepting client feedback:** After an event, the client can provide feedback on the workers - whether they prefer or ban a worker. If the client leaves feedback, it will show on the Dashboard under Client Preferred & Banned Workers.
If you click *Accept* on the green thumbs up, it will add the worker to the client's Preferred list and will mark them as preferred for this client's events. If on the red thumbs down, the worker will be added to that client's Banned list and will not be able to see future events with that client. You can always reverse accepting the client's feedback through Client Preferred & Banned Workers, by dragging and dropping workers from the edit client page.
Please check our video which covers the topic inside out!
# Shift Request
Source: https://docs.roostedhr.com/guides/workflows/shift-request
What are shift requests?
Shift requests are shifts that workers have asked to work on. You can enable or disable this feature through your settings. Workers can submit a shift request from one Desktop/Mobile browser or Mobile app:
## Desktop/Mobile Browser
On a Desktop or Mobile Browser, workers can go to their homepage by clicking the house icon in the top right corner.
From here, the worker can see all their available shifts in the Available Shifts section:
Workers can view the details of the event and shift. To request, they click "Request" and confirm.
When a worker has submitted a request, they can remove it by clicking "Remove request" and confirming their choice.
## Mobile App
### Available shifts
Next, the worker must tap *Request* on the shift they want to Request & confirm. They will receive confirmation that the request has been submitted.
## Shift Request Settings
To manage shift request settings, follow these steps:
1. **Access Settings:**
2. Blue admin bar - **Configuration**.
3. Then select **Settings**.
4. Click on **Shift Options** and you'll find **Shift Request** at the very top.
5. **Adjust Settings:**
6. If **Shift Requests Active** is toggled on, you can adjust the following settings:
7. **Comments:** Allows workers to submit comments with their shift requests.
8. **Sign-Up Bot Request:** If toggled on, the Sign-Up Bot will contact workers to request their interest. If they respond positively, these responses will be converted into requests. If toggled off, a positive response will directly sign the worker up for the shift.
9. **Send Text Message on Denial:** Sends a text message to the worker if their shift request is denied.
10. **Send Text Message on Approval:** Sends a text message to the worker if their shift request is approved.
11. **Email Admins on Request Submission:** Sends an email to the event admins when a shift request is submitted.
12. If **Shift Requests Active** is toggled off, the five settings above will be greyed out and unavailable for adjustment.
## How to approve Shift Requests?
Please, see **[Approving Shift Requests](https://support.roostedhr.com/en/articles/9497152-approving-shift-requests)** for more information.
And that is how you can use Shift Requests as part of your Shift Options for workers through Roosted! π
# Shift Sign-Up
Source: https://docs.roostedhr.com/guides/workflows/shift-sign-up
How to allow your workers to sign up for available shifts?
**Shift Sign-Up** allows your workers to sign up for available shifts, provided they have the required skillset and meet the applicable rules (tags and custom fields) set for the shift. Workers can sign up for shifts in one of two places:
## Desktop/Mobile Browser
From the Desktop or Mobile Browser, a worker can head to their homepage by clicking the house icon in the top right (*workers who are not admin or owners are automatically directed here when the login*).
From this page, the worker can see all their available shifts by clicking Go to Available Shifts.
A worker can view details of the event and to sign-up, they have to click SIGN-UP and confirm!
When a worker has signed up for a shift, they will appear as shown below on the **Main Event Page**.
## Mobile App
On the Mobile App, a worker can log in and tap Available Shifts.
From the next page, choose Sign Up on the shift they want to sign up for and confirm. The worker will receive confirmation that they have been signed up.
**Shift Sign-Up** is available to workers when you have turned **[Shift Requests](./shift-request)** off through Configuration - Settings - Shift Options - Shift Requests. If you want your workers to request shifts, opposite to direct sign-up, you can do so by turning **[Shift Requests](./shift-request)** on.
And this is how Shift Sign-Up works on Roosted! π
# Sign Up Bot
Source: https://docs.roostedhr.com/guides/workflows/sign-up-bot
Let's discover our favorite robot - Sign Up Bot! We have named him so because it will automatically reach out to your workers to fill empty shifts through push notifications and text messages depending on the app settings. This feature is a fail-saver when you have unfilled skillsets for a shift that is to happen soon. When that happens, Roosted will begin notifying and texting your best workers and giving them the opportunity to sign up.
## Here's an example of Sign Up Bot sending a text
## 3 Minute Trainer Video
When using Sign-Up Bot to fill shifts, it will follow any rules of preferred workers you have set. Please see **[Rules](https://support.roostedhr.com/en/articles/9497157-rules)** for more information.
## Additional Sign-Up Bot Features
Additional features of Sign-Up Bot are:
***Last Contacted*** will show the last time a notification was sent to workers.
By clicking LAST CONTACTED, you will see the Sign-Up Bot Statistics:
* *First message sent to* - the number of workers that a notification was sent to. It will show the list of people along with their phone number, contact date, and amount of notifications.
* *People asking for more details* - the number of workers that requested more information.
* *Confirmed* - the number of workers that Confirmed for the shift.
* *Declined* - the number of workers that Declined the shift.
## Resending Sign-Up Bot Messages
When the Sign-Up Bot has messaged all workers who can fill a shift, but there are unfilled spots, you can resend messages by clicking RESEND SIGN UP BOT on the shift edit screen.
## Sign-Up Bot - How does it work?
The Bot will contact workers starting from the highest rated to the lowest ones. It will individually offer the shift to workers who have the required skills and no schedule conflicts (such as time off or already working during that shift). You can preview which workers will be contacted by clicking "Click To Fill," as if you were manually assigning a shift. If the shift is planned way ahead, the Sign-Up Bot will give preferred workers more time to respond. If it is a short notice, it will reach out to all available workers to fill the shift as a priority.
## Sign-Up Bot Settings
Please, see **[Sign-Up Bot - Settings](https://support.roostedhr.com/en/articles/9491520-sign-up-bot-settings)** for more information.
**Workers activating push notifications** - can be done from the mobile app settings or when it asks for permission.
## Phone Number Format
* For US and Canadian customers, phone numbers are in the 10-digit format, with no dashes or dots - **8582252328**
* For international customers, add a + country code to the number first - for England **+44 20 7123 4567**
* *We support text messaging to hundreds of countries* - if you are unsure how to enter your number you can either test it out or submit the helpdesk ticket.
# Workflows
Source: https://docs.roostedhr.com/guides/workflows/workflows
How can you add a worker to a shift? There are multiple ways!
In this article, we will discuss all the different methods you can use through Roosted to fill available shifts at your events.
## **Direct Assignment**
This method involves directly assigning a worker to an available shift. See **[Direct Assignment](https://support.roostedhr.com/en/articles/9497189-direct-shift-assignment)** for more information.
## Invite To Work
The **Invite to Work** feature allows you to offer shifts to workers even if you're unsure of their availability. This feature sends an invitation that the worker can either accept or decline. See **[Invite To Work](https://support.roostedhr.com/en/articles/9497193-invite-to-work)** for more information.
## Preferred Workers
This is the method of you selecting which workers you would prefer to work this shift, you can also set an expiry so it will open to all workers with that Skillset should your preferred workers not fill all of the available spots within the selected expiry time. See **[Preferred Workers](https://support.roostedhr.com/en/articles/9497199-preferred-banned-workers)** for more information.
## Shift Sign-Up
This is the method of allowing your workers to directly sign-up for available shifts. See **[Shift Sign-Up](https://support.roostedhr.com/en/articles/9497212-shift-sign-up)** for more information.
## Shift Request
Alternatively, you have to allow your workers to request to work an available shift. See **[Shift Request](https://support.roostedhr.com/en/articles/9497202-shift-request)** for more information.
## Sign-Up Bot
Sign-Up Bot is our power automated system that will reach out to workers to fill available shifts. See **[Sign-Up Bot](https://support.roostedhr.com/en/articles/9497214-sign-up-bot)** for more information.
And these are all the ways you can fill open shifts using Roosted! π
# Getting Started
Source: https://docs.roostedhr.com/api-reference/getting-started
Roosted HR Enterprise API reference
The Roosted API is organized around REST. All requests and responses use JSON.
Sandbox and production API keys are available by contacting [support@roostedhr.com](mailto:support@roostedhr.com).
## Welcome
The Roosted API gives you programmatic access to the Roosted workforce scheduling platform. Use it to manage events, shifts, workers, clients, time tracking, and more β directly from your own systems.
```
https://api.roostedhr.com/api/1_12
```
```
https://sandbox.roostedhr.com/api/1_12
```
## Authentication
All API endpoints require an API key. Include it in the `X-API-KEY` header of every request.
```bash theme={null}
curl -X GET https://api.roostedhr.com/api/1_12/events \
-H "X-API-KEY: YOUR_API_KEY"
```
Contact [support@roostedhr.com](mailto:support@roostedhr.com) to request your sandbox and production API keys.
# Create Announcement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/announcements/create-announcement
api-reference/v01.12.00/openapi-v01.12.00.json POST /announcements
Creates and sends an announcement to workers via email, text message, or both. Target all workers, a specific skillset, or a list of individual workers.
## Targeting workers
You can target announcement recipients in three ways:
* **All workers** β set `all` to `1`. The `selected_workers` and `skillsets` fields are ignored.
* **By skillset** β set `all` to `0` and provide a `skillsets` ID. Only workers with that skillset receive the announcement.
* **Specific workers** β set `all` to `0` and provide an array of worker IDs in `selected_workers`.
## Delivery channels
The `output` field controls how the announcement is delivered:
| Value | Channel |
| ----- | --------------------------- |
| `1` | Email only |
| `2` | Text message only |
| `3` | Both email and text message |
The `message` field supports HTML formatting. Keep the content under 1,000 characters.
# Get Announcement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/announcements/get-announcement
api-reference/v01.12.00/openapi-v01.12.00.json GET /announcements/{id}
Returns a single announcement by ID, including its subject, message body, delivery channels, recipients, and status.
# Get Announcements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/announcements/get-announcements
api-reference/v01.12.00/openapi-v01.12.00.json GET /announcements
Returns a paginated list of announcements for your company, ordered by most recent first.
Both `page` and `items_per_page` are optional. If omitted, the API returns the first page with the default page size.
# Create Area
Source: https://docs.roostedhr.com/api-reference/v01.12.00/areas/create-area
api-reference/v01.12.00/openapi-v01.12.00.json POST /areas
Creates a new area. Areas can be organized hierarchically by setting a parent_id.
To create a child area, set `parent_id` to the ID of an existing area. Omit `parent_id` (or pass an empty string) for a top-level area.
# Delete Area
Source: https://docs.roostedhr.com/api-reference/v01.12.00/areas/delete-area
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /areas/{id}
Permanently deletes an area. Protected areas and areas with children cannot be deleted.
An area cannot be deleted if it is **system-protected** (`ARA-800`) or has **child areas** (`ARA-900`). Reassign or delete child areas first before deleting a parent.
# Edit Area
Source: https://docs.roostedhr.com/api-reference/v01.12.00/areas/edit-area
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /areas/{id}
Updates an area's name or position in the hierarchy.
The API validates against circular references β an area cannot be set as its own parent (`ARA-500`). Only `name` and `parent_id` can be updated; the `id` is immutable.
# Get Area
Source: https://docs.roostedhr.com/api-reference/v01.12.00/areas/get-area
api-reference/v01.12.00/openapi-v01.12.00.json GET /areas/{id}
Returns a single area by its ID.
# Get Areas
Source: https://docs.roostedhr.com/api-reference/v01.12.00/areas/get-areas
api-reference/v01.12.00/openapi-v01.12.00.json GET /areas
Returns all areas for your company, including their hierarchical relationships.
Areas represent geographic or organizational regions used to group locations, workers, and events. They support a parent-child hierarchy β each area can optionally reference a `parent_id` to nest under another area.
The response returns a flat list of all areas. Use the `parent_id` and `nlevel` fields to reconstruct the hierarchy on the client side.
# Add Template Requirement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/add-compliance-template-requirement
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-compliance-templates/{id}/requirements
# Add Contract Admin
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/add-contract-admin
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/admins
# Add Stage Requirement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/add-stage-requirement
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/{id}/requirements
# Advance Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/advance-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/advance
Requires `target_stage_id` in the request body. This endpoint does not trigger notifications β integrators manage their own notification flows.
# Apply Compliance Template to Contract
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/apply-contract-compliance
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/compliance/apply
# Batch Create Applications
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/batch-create-applications
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/applications/batch
Maximum 100 `personnel_ids` per request. Duplicate entries are skipped. Response includes `created` and `skipped` counts.
# Complete Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/complete-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/complete
# Complete Task
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/complete-task
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-tasks/{id}/complete
# Create Task
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-application-task
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/tasks
# Create Compliance Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-compliance-template
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-compliance-templates
# Create Contract
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-contract
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts
# Create Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-contract-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/applications
# Create Pipeline
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-pipeline
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-pipelines
# Create Stage
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-pipeline-stage
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-pipelines/{id}/stages
# Create Task Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-stage-task-template
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/{id}/task-templates
# Delete Compliance Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-compliance-template
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-compliance-templates/{id}
# Delete Template Requirement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-compliance-template-requirement
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-compliance-templates/{id}/requirements/{req_id}
# Delete Contract
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-contract
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-contracts/{uuid}
# Delete Pipeline
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-pipeline
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-pipelines/{id}
# Delete Stage
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-stage
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-stages/{id}
# Delete Stage Requirement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-stage-requirement
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-stages/{id}/requirements/{req_id}
# Delete Task Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-task-template
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-task-templates/{id}
# Update Compliance Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-compliance-template
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}
# Update Template Requirement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-compliance-template-requirement
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}/requirements/{req_id}
# Update Contract
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-contract
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-contracts/{uuid}
# Update Pipeline
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-pipeline
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-pipelines/{id}
# Update Stage
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-stage
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-stages/{id}
# Update Task
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-task
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-tasks/{id}
# Update Task Template
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-task-template
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-task-templates/{id}
# Get Default Requirements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-compliance-template-defaults
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates/defaults
# List Template Requirements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-compliance-template-requirements
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates/{id}/requirements
# List Compliance Templates
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-compliance-templates
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-compliance-templates
# Get Contract
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}
# List Contract Admins
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-admins
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/admins
# List Contract Applications
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-applications
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/applications
# Get Contract Compliance Requirements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-compliance
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/compliance
# Get Credential Visibility
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-credential-visibility
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/credential-visibility
# Get Contract Custom Fields
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-custom-fields
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/custom-fields
# List Eligible Personnel
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contract-eligible
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts/{uuid}/eligible
Paginated. Use `page` (default 1) and `items_per_page` (max 100) to navigate results.
# List Contracts
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-contracts
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-contracts
Paginated. Use `page` (default 1) and `items_per_page` (max 100) to navigate results.
# List Pipeline Stages
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-pipeline-stages
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-pipelines/{id}/stages
# List Pipelines
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-pipelines
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-pipelines
# List Stage Requirements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-stage-requirements
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages/{id}/requirements
# List Task Templates
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-stage-task-templates
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages/{id}/task-templates
# List All Stages
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-stages
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-stages
# List Tasks
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-tasks
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-tasks
Paginated. Use `page` (default 1) and `items_per_page` (max 100) to navigate results.
# Place Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/place-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/place
This endpoint does not trigger notifications β integrators manage their own notification flows.
# Reject Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/reject-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/reject
This endpoint does not trigger notifications β integrators manage their own notification flows.
# Remove Contract Admin
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/remove-contract-admin
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-contracts/{uuid}/admins/{personnel_id}
# Reorder Stages
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/reorder-stages
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-stages/reorder
# Set Compliance Template Default
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/set-compliance-template-default
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-compliance-templates/{id}/default
# Set Credential Visibility
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/set-contract-credential-visibility
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/credential-visibility
# Set Contract Custom Field Value
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/set-contract-custom-field
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-contracts/{uuid}/custom-fields
# Set Default Pipeline
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/set-pipeline-default
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-pipelines/{id}/default
# Withdraw Application
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/withdraw-application
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-applications/{id}/withdraw
# How does Roosted bill?
Source: https://docs.roostedhr.com/guides/billing/how-does-roosted-bill
How will you be charged for our service?
Roosted charges for two things:
* Active workers
* Use of the Time Tracking module. This allows your bill to scale up and down with your business so that you're only paying for what you use, as you may or may not be using the Time Tracking module.
## How active workers are billed
* Each day, Roosted records how many active workers you have on your account
* On the first day of every month, Roosted charges you for the average total number of active workers in the previous month
* **Inactive workers are not counted**, but their data is never deleted as long as your account is open and in good standing.
## Time Tracking Module
* Due to the complexity of Time Tracking, this module has an additional charge, which is billed per active worker
## Why does Roosted count for active workers and not logins?
* Roosted and its bots use lots of resources, like text messaging.
* We provide unlimited support and training to all clients.
* These items have hard costs attached, so Roosted bills are based on those hard costs.
## Where can I check my bill?
* From the main menu, click on Configuration > Company Info
* You may be on an Enterprise plan or have bulk-negotiated rates, so your bill may appear differently than stated above.
# Admin/Owner Dashboard
Source: https://docs.roostedhr.com/guides/dashboard/adminowner-dashboard
Admin dashboard and what it offers!
In this article, we will discuss the dashboard and how you can use it to complete day-to-day tasks.
When an Admin/Owner logs in, you will be directed to your Dashboard where you can complete the following tasks: **PENDING REVIEWS**
If you have been assigned as an Event Reviewer, you can submit reviews for workers who worked shifts at events you reviewed. Click **Go to Pending Reviews**. For more details, see [Event Reviewer](../reviews/event-reviewer).
## Pending Worker Transfers
You can approve or deny worker transfers, which are potential employees who have applied to your company through an integrated ATS (Applicant Tracking System). Please see **[Worker Transfers](https://support.roostedhr.com/en/articles/9491848-worker-transfers)** for more information.
## Time Tracking
If an admin has time tracking capabilities, they can view pending and/or missing time punches for the current or previous periods. They can easily review these punches by clicking **Go to Time Tracking**. Please see **[Time Tracking Module](https://support.roostedhr.com/en/articles/9497248-time-tracking-module)** for more information.
## Upcoming Check-Ins (Graph)
This bar graph displays information on daily check-ins, including:
* **Total Number of Check-Ins**: The overall count of check-ins expected for the day.
* **Number of Workers Checked In**: The count of workers who have completed their check-ins.
* **Number of Workers Not Checked In**: The count of workers who have not yet checked in.
## Upcoming Check-Ins (Pie Chart)
This pie chart illustrates the percentage of workers who have:
* **Checked In**: The proportion of workers who have completed their check-ins.
* **Not Checked In**: The proportion of workers who have not yet checked in for upcoming events.
## Client Preferred & Banned Workers
If your Client has submitted feedback about your workers through the **Client Portal**, their suggestions will appear here.
1. **Green Thumbs Up (ACCEPT)**: Clicking this will add the worker to the client's Preferred list. This means the worker will be automatically selected as a preferred choice for future events created for this client.
2. **Red Thumbs Down (REJECT)**: Clicking this will add the worker to the client's Banned list. The worker will not be able to see or be assigned to future events with this client.
## Late & No Show
This line graph will show you the number of LATE & NO SHOWS that have happened on each day.
## Recent Bailouts
This graph displays the number of bailouts that occurred each day. It also provides details on when these bailouts happened:
* **More than 72 hours before shift start**
* **Within 24 to 72 hours of shift start**
* **Less than 24 hours before shift start**
## Pending Document Signing Requests
See which workers have received Document Signing Requests but have not yet completed them. You will see a list of these workers. By clicking the arrow down, you can view the specific documents that are still pending. Please see [Document Signing](../documents/document-signing) for more information.
## Payroll Projection
You can view your current payroll projection total and examine a line graph showing daily projections. These projections are based on the shifts and workers scheduled for each day. To view projections for the next payroll period, click **SWITCH TO NEXT**.
## Recent Shifts
From here, you can view a breakdown of all recent completed shifts, including star ratings, comments, and any issues such as absences or lateness marked by the reviewer.
Check our latest video which describes the system inside out!
And this is how you can use your Dashboard as an Admin/Owner through Roosted!
If you have any questions or want to learn how to get more from your Roosted account, please contact your Client Support Specialist or get in touch with our support team through [support@roostedhr.com](mailto:support@roostedhr.com) π€
# Calendar Sync - Workers
Source: https://docs.roostedhr.com/guides/desktop/calendar-sync-workers
How to sync your calendar with Roosted app?
Roosted gives you the ability to sync your shifts to your personal calendar depending on your company settings.
β
From your Roosted account, click the person icon in the top right corner - View/Edit Profile - Calendar Sync. On this page, you will see instructions on how to sync your calendar to Apple or Google. You can also copy the link under 'Alternate Method' and paste this link into any other calendar provider you use when subscribing to a new calendar. The calendar will sync your past and next 3 months of shifts. The update frequency of your calendar depends on the service you use, so the information may not be up to the minute. For example, Google and Gmail calendars may be as much as 12 hours behind, whereas Apple tends to be more up-to-date. For the most updated, real-time information, please check your Roosted app. Check out our YT tutorial explaining the topic inside out!
# Homepage (Desktop)
Source: https://docs.roostedhr.com/guides/desktop/homepage-desktop
How to navigate through your Roosted account?
On your Roosted app homepage, you will see some different sections. Along the top of the page you will see the following:
**Pending Reviews**
Review the work of the worker. This feature offers a detailed summary of each workerβs tasks, including event name, location, and date. Supervisors can examine pending reviews to analyze factors affecting worker performance, which is essential for assigning star ratings.
**Available Shifts**
The "Available Shifts" section is a list of shifts you can sign up for or request, depending on your company's settings. Here, you can view details such as the event date, event name, and the types of shifts available (e.g., Hands, Bartender). To view additional information click '**Go to Available Shifts**'. See **[Available Shifts](https://support.roostedhr.com/en/articles/9484645-available-shifts-desktop-mobile-app)** for more information.
**Next Shifts**
The "Next Shifts" section displays events you have been assigned to, requested (and approved for), or signed up for directly. Depending on your companyβs settings, you will see details such as:
* **Event Name** (e.g., Blue Strike Day 3)
* **Event Date** (e.g., Saturday, June 4)
* **Position** (e.g., Hand)
* **Shift Time** (e.g., 12:00 PM - 8:30 PM)
* **Location** (e.g., Dodger Stadium)
Depending on your companyβs settings, you might also be able to view the β**Reviewer**β and β**Location Comments**.β You can sign up for or request shifts based on your company's policies. For more details on the events youβve signed up for, or to see a complete list of all shifts youβve signed up for or been approved for, click 'Go to My Shifts.' '**Go to My Shifts**'. See **[Next Shifts](https://support.roostedhr.com/en/articles/9484356-next-shifts-current-shifts)** for additional information.
**Blogs**
Depending on your company settings, you might find a section called "Blogs" below "Next" and "Available Shifts." This section allows your employer to share updates with you and your colleagues. To view all company blogs, simply click 'View Blogs.' See **[Blogs](https://support.roostedhr.com/en/articles/9484617-blogs-desktop-mobile-app)** for more information.
**Calendar**
On your homepage, you'll also have access to your calendar. Depending on your settings, you can use it to:
* View and submit your availability
* View and submit time-off requests
* View and submit time punches
* View and submit reimbursements
To access your calendar, click 'Go to Calendar.' See **[Calendar](https://support.roostedhr.com/en/articles/9490982-worker-calendar)** for more information.
**Company Documents**
You might also find a "Company Documents" section on your Roosted homepage. This area can be used to access important documents such as company handbooks, policies and procedures, payroll information, and Roosted training materials. See **[Company Documents](https://support.roostedhr.com/en/articles/9484845-company-documents-desktop-mobile-app)** for more information.
**Pending Document Signing Requests**
You might see document signing requests on your homepage. These requests allow you to complete and sign important documents, such as company handbooks or government forms like I-9s and W-4s, among others. See **[Pending Document Signing Requests](https://support.roostedhr.com/en/articles/9484684-pending-document-signing-requests-desktop-mobile-app)** for more information! Make sure to check our YouTube video expanding the topic inside out:
# Pending Reviews - Desktop
Source: https://docs.roostedhr.com/guides/desktop/pending-reviews-desktop
Reviews of your worker and colleagues - how do they work?
In this article, we will review your desktop view's reviews section. On your Roosted homepage, you might see a section labeled **Pending Reviews**. This indicates that you have been assigned as the reviewer for past events and are requested to submit reviews for your colleagues.
To complete the reviews, click **Pending Reviews**, and you will be redirected to all the pending events. Here, you will see the event's name, location, and date.
Click REVIEW on the right to start the review.
On the next page, you'll see a list of all workers who worked in the event. For each, you can do as follows:
**Submit 1-5 star review**
**Mark as late**
**Mark as absent**
**Flag for review**
By flagging for review, the management team will receive an email indicating a possible issue with this worker that needs to be checked.
**Comments**
**In the reviews, the only mandatory item is the 1-5 star rating, everything else is optional.** Once you have gone through the list and entered your reviews, click **SUBMIT REVIEWS** to complete.
If you notice that SUBMIT REVIEWS appears in grey, means that is one or more worker that you have not entered a review for. Once you have submitted your reviews, this event will be removed from your pending review list. **Remember to enter reviews fairly and honestly**! Your place of work has trusted you with this responsibility and it is vital feedback to your employer.
# View your Past Shifts
Source: https://docs.roostedhr.com/guides/desktop/view-your-past-shifts
Past shifts and ratings - how to manage them?
On your Roosted account, you can review your past shifts, or see star ratings and comments from event reviewers, if any were provided. You can access this by clicking the profile icon on the top right - Past Shifts.
Here, you can see a list of the shifts you have worked, how many times you have been marked late, and how many times you have been marked as a no-show.
If there are any visible comments and star ratings, you will see them below the event name.
And this is how you view your past shifts through Roostedhr! π
# Document Signing
Source: https://docs.roostedhr.com/guides/documents/document-signing
Get your documents signed within the app.
## What is Document Signing?
Document signing in Roosted allows you to send documents to workers for them to complete and sign. This includes various forms such as worker policies, government documents like W-9s, and more.
## How Does It Work?
### Access Document Signing
1. Go to a worker's profile in the Workers Module.
2. Click the wrench icon next to the worker's name.
3. Navigate to Worker Info and select Documents.
### Send Documents to Sign
1. In the Documents section, choose Document Signing Requests.
2. Select from the available templates or upload new ones.
3. Submit a document signing request, and an email will be sent to the worker prompting them to sign the documents.
4. Workers can also view and sign their documents via the mobile app or website.
### Document Management
Once signed, Roosted automatically adds the completed documents to the worker's uploaded documents section.
For documents requiring additional signatures (e.g., W-4s, I-9s), you can set up a process to capture multiple signatures.
## How Do I Add Templates?
To add templates:
* Send the documents to Roosted.
* We will work with you to organize and set up your templates according to your requirements.
## How Do I Send Templates?
### Navigate to the Workers Module
1. Click the blue Admin bar on the left side of the screen.
2. Select Workers.
### Initiate Document Signing
1. Click the wrench icon next to the workerβs profile.
2. Go to Worker Info and then Documents.
3. In the Document Signing Requests section, you can view and manage document signing statuses, including Pending, Completed, Declined, or Cancelled.
By following these steps, you can efficiently manage document signing and ensure all required documents are completed and stored properly.
## Document Signing Statuses
### Pending Requests
These are requests that have been sent to the worker but have not yet been signed.
### Completed Requests
These are requests that have been signed by the worker, with the completion date noted.
### Declined Requests
These are requests that the worker has declined, along with the date of decline.
### Canceled Requests
These are requests that have been canceled by you, with the cancellation date noted.
## How to Send a New Document Signing Request
1. **Initiate a New Request:** Click on NEW REQUEST.
2. **Select Document:** Choose the document you want to send from the dropdown list.
3. **Send the Request:** Click SEND REQUEST.
This will prompt an email to the worker, asking them to complete and sign the selected document.
After Sending a Request the request will appear under **Pending** in the Document Signing Requests list on the worker's profile.
## Sending Multiple Document Signing Requests
1. **Navigate to the Workers Module:** Go to the Workers Module via the blue admin bar on the left-hand side.
2. **Select Workers:** Click the checkbox in the top-left corner of each worker's profile to select multiple workers.
3. **Send Requests:** Follow the steps to send Document Signing Requests to the selected workers. This will streamline the process for managing multiple document signing requests at once.
You can also select all workers by clicking the box at the top left of the page.
When you have selected multiple or all workers, you will see a box that informs you how many workers have been selected and from here you can click to expand the dropdown option.
From the dropdown, select **Send Document Signing Request**. Then, choose the envelopes you want to send to the selected workers. Once youβve made your selections, click **SEND REQUEST**.
When you **SEND REQUEST**, you will be charged per envelope as outlined in your proposal. For more details, please contact your Client Success Specialist.
## Where do Pending Documents Appear for Workers?
Pending documents will appear on the worker's homepage, both on the desktop and mobile app.
## How can I Check Which Signing Requests Have Been Sent to Workers?
Admins and Owners can view a list of Pending Document Signing Requests from their Dashboard. By expanding each workerβs name, you can also see the dates when these requests were sent.
Check our video which explains the topic to the fullest:
And this is how document signing works through Roosted! π
# Document Uploading
Source: https://docs.roostedhr.com/guides/documents/document-uploading
How to upload documents into events and workers profiles?
Document uploading helps to provide information about an event to the team or to store documentation on a worker's profile.
## What kinds of documents can I upload?
All types can be uploaded. Max file size of 50MB.
## In what areas can I upload documents?
1. Events
2. Company Documents
3. Worker(s) profile
## Events
### Calendar View
Uploading documents in an event.
* they can be added from the event editing section
* workers can download uploaded documents
### Side By Side View
* click DOCS at the top of the event.
* click or drag the document to attach it to this event.
## Company Documents
General company documents can be added. For example:
* a general dress policy
* workplace policies
* payroll information, etc.
They can be added through Configuration & documents to be viewed by all workers.
***Company documents on worker homepage - Desktop:*** Here they can be viewed and downloaded by workers.
***Company documents on worker homepage - Mobile App:*** Here they can be viewed and downloaded by workers.
## Workers Profile Documents
Workers can have their documents such as driver's licenses and I-9 stored too. To add them, choose the wrench of the worker, documents & upload or drag the document onto the worker profile. Any finished document signing documents will also appear here. Please see [Document Signing](./document-signing) for more information.
And that's how you can upload and use documents through Roosted! π
# Available Shifts (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/available-shifts-desktop-mobile-app
Logging in, picking up new shifts, and viewing your current and upcoming shifts with ease.
In this article, we will explain Available Shifts on your Roosted account. On your **homepage**, in the top right, you can view the *Available Shifts* - to those, you can sign up for or request to work. To view the full list and additional details, click '**Go to Available Shifts**'.
There, you can see additional information:
* of all of the shifts you can sign up for or request
* submitted outstanding requests if your company uses the request system
* each event shifts - Hand & Bartender shift available for example as below
Click **REQUEST** to request the shift given.
When requesting a shift you may also be able to send comments:
If you have submitted a request which has not been approved yet, you can simply click **REMOVE REQUEST** & confirm.
If your company uses the sign-up system, instead of seeing **REQUEST** you will see **SIGN-UP.** To sign up for a shift, click **SIGN-UP** and confirm.
Once you have signed up for a shift, it will be moved from Available Shifts to Next Shifts. If there are multiple shifts on one event, you can only sign up for one of them, unless **they are at different times of the day** i.e. Morning & Evening, and your companyΒ΄s setting allows this action. Mobile App On your Mobile App homepage, you will see AVAILABLE SHIFTS at the very top of your screen.
By clicking, you will see all of the shifts you can sign up for or request. If your company uses the request system, you will also see outstanding requests that you have submitted.
The Request & Sign-Up system works exactly the same on the Mobile App as it does on the Desktop version! And this is your Available Shifts through Roosted! π
# Bailout (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/bailout-desktop-mobile-app
How to bailout from the shift and what are the possible consequences?
**Desktop** On Roosted, depending on your company settings, you may have the option to bailout. You can find the bailout button to the right of the Check In button. If your company does not use the bailout system or the shift falls within a locked bailout period, the button will appear in black font. If the system is active and the shift is outside the locked period, the button will be displayed in red font.
If the bailout button is locked, you will receive a message indicating that the bailout option is unavailable for this shift. This message will also provide contact information specific to your company and may include a warning messag.
The above contact information is for example purposes only. **DO NOT** contact [support@roostedhr.com](mailto:support@roostedhr.com) to bailout. If a bailout is available, after clicking you will be prompted to confirm and you may be shown a warning message from your company.
If you confirm the bailout, this shift will be removed from your My Shifts and your company may be sent a notification that you have bailed out from this shift. **Mobile App** On the Mobile App - on your CURRENT SHIFTS - you will also see the BAIL OUT button.
If your company does not use the bailout system or if bailouts are locked for the shift's period, the option will be greyed out. In this case, tapping the greyed-out option will display your company's HR contact information, to reach out to them directly. If the BAILOUT button is available, it will appear in blue as shown below.
To bailout, tap & confirm. It is very important to bear in mind that if you bail out from a shift, **this may affect your Roosted rating and damage your ability to pick up shifts in the future.** Check out our YouTube tutorial covering the topic inside out!
# Blogs (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/blogs-desktop-mobile-app
Blogs as new's and updates from your company.
Blogs are sections you see on your RoostedΒ **homepage**Β (*Desktop*) or your Menu (*Mobile App*), and they are used as a way for your place of work to share information with you. This could include company announcements, changes to processes, or even regarding upcoming employee competitions or incentives. On the Desktop, to view a list of blogs from your company, on your homepage, simply click **View Blogs**
Blogs are also viewable on your Mobile App - tap the hamburger icon (top left) & select Blog.
And this is where to find blogs on both your Desktop & Mobile App! π
# Check-In
Source: https://docs.roostedhr.com/guides/general/check-in
How to use Check-In feature on Desktop & Mobile App
In Roosted, Checking-In to your shift is very similar to a pre-flight check-in. When you Check-in, you let your employer know that you are ready to work on that particular shift. Usually, it is done a few days before the shift itself. It is a way of confirming that you are coming to work. Easy, right? If your company uses the Shift Check-In system, you will receive a notification in a certain number of days before your shift is due to start. Depending on company settings it can be an email, SMS, or push notification. You may also click Check-In on your Roosted account if it is within the Check-In period. It is important to remember, that Checking-In is completely different than Punching-in & Punching-out. Check-in informs your company that **you will be there** (typically 2-3 days before the shift), Punching in & out is actually starting and ending your shift. You can easily do the pre Check-In on both desktop & the mobile app. **Desktop:** To Check-In, enter **My Shifts**:
If the Check-in is already possible, the button will be shown in a blue font. If not, the font will be black. Click the Check-in button and confirm. You will receive a confirmation via email or text message - click the link on the message received. **Mobile App:** On the homepage, tap CURRENT SHIFTS or My Shifts (visible in the hamburger icon β°), and you will be able to Check-In. If it is too early to Check-In or your company does not use the Shift Check-In system, this box will be grey.
If Check-In is possible, the button will be blue and active. If you have already done that, it will say CHECKED IN.
You must confirm the Check-In so your employer knows that you are available to work. If you have not confirmed your Check-in, your company may find a replacement. Please check our YouTube trainer for an even better view!
# Company Documents (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/company-documents-desktop-mobile-app
Extra information added by your place of work.
Your employer uploads company documents, which may include the handbook or payroll information. They can be viewed and downloaded from your account & Mobile App. **Desktop view:** Click to download to your computer from the homepage.
**Mobile App:** Documents are visible from the homepage of the Mobile App.
Tap to see the document and download it. It is recommended to download a PDF viewer to your device to open documents easily.
# Logging in for the 1st time (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/logging-in-for-the-1st-time-desktop-mobile-app
How to log in and what are the first steps to set up your Roosted account?
## First Login Experience
When you log in to Roosted for the first time via a web browser, youβll be greeted with a welcome message and a link to a YouTube playlist with helpful tutorials.
Click "Start" to proceed and youβll be prompted to change your password.
## Profile Setup
Next, youβll land on your profile screen. Here, you can update your details like phone number, email, and address. If allowed by your company, you can also upload a new profile picture.
Additional fields may be available on the second tab. You can also sync your Roosted calendar with your personal calendar (Google, Apple, etc.). See more in **[Calendar Sync.](https://support.roostedhr.com/en/articles/9490993-calendar-sync-workers)**
## Mobile App Experience
The mobile app login process mirrors the web experience. You'll see the same greeting and video playlist link.
After setting your password, you can update your profile details and upload a new picture.
Access the full Roosted app by clicking the three-line icon in the upper left corner.
For more detailed tutorials, be sure to check out the other videos in the provided playlist and the dedicated video:
And this is what the first-time Roosted login looks like!
# Next Shifts / Current Shifts
Source: https://docs.roostedhr.com/guides/general/next-shifts-current-shifts
Upcoming shifts in desktop and app view.
In this article, we will introduce the **Next Shifts** on your account, on both the desktop & mobile app. In the top left of the **homepage**, you can view your *Next Shifts:*
Here you will see shifts you have been assigned to, signed up for, or have been approved to work at. To view the full list and additional details, click '**Go to My Shifts**'. On this page, depending on your company settings, you can see the details of the event: venue, shift times, or your coworkers. It will also allow you to **Check-in** (*letting your workplace know that you will be there*) or **Bailout** (*dropping out from your shift*).
On the Mobile App, this page is named CURRENT SHIFTS and is visible directly from your homepage.
When you tap 'CURRENT SHIFTS,' you will see all the shifts you are currently signed up for, the ones you have requested and been approved for, or shifts you have been directly assigned to by your company. They will appear in chronological order.
Every shift will include the name of the event, its date and time, and a link to the location. You may also be able to **Check-in**, **Bailout,** and when it is time, **Submit Time Punches**. The arrow in the top right will open an additional details view - a map of the venue location and any comments related to the venue (*i.e. parking instructions*). Depending on your company settings, you may also see a list of your co-workers from the same shift or from the same event.
Feel free to check out our quick YouTube trainers!
And this is how you can view your shifts on both the Desktop & Mobile App on Roosted! π
# Notifications, Announcements & Chat (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/notifications-announcements-chat-desktop-mobile-app
Easier communication with your workplace!
Your place of work will occasionally use the chat system to communicate with you. On the desktop, you can view Notifications & Chats by clicking the speech bubbles along the top right of the page.
Any announcements or chats sent out by your company can be viewed under Notifications & Announcements.
You can view & reply to this chat by clicking into the chat, picture above.
To add a message to the chat, click in the message box at the bottom, type your message, and then either click the blue up arrow or press Enter/Return on your keyboard.
Once you have entered your message, it will appear in the chat, and all participants in the conversation will be able to see your reply.
Mobile App On the Mobile App, you can access Chat from the main homepage, where you'll see it listed at the top of the page or on the side menu.
Notifications, Announcements, and Chats are consistent across both the Desktop and Mobile Apps. Please remember to be respectful when using the chat function, as your messages can be seen by colleagues and management. And this is how you can communicate using the Roosted Chat! π
# Office Hours and Support Availability
Source: https://docs.roostedhr.com/guides/general/office-hours-and-support-availability
When weβre here to assist you.
Our team is available to assist you during our regular office hours:
* **Monday to Friday:** 7:00 AM β 3:00 PM (Chicago Time, CST/CDT)
* **Closed:** Saturdays, Sundays, and major holidays
If you contact us outside these hours, weβll get back to you as soon as possible once weβre back online. Thank you for your understanding, and we appreciate your business!
# Pending Document Signing Requests (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/pending-document-signing-requests-desktop-mobile-app
Sign and submit documents requested by your company: handbook, policies and procedures, and more!
Document signing requests are used to allow you to sign and submit documents that have been requested by your company, which could include a company handbook, policies and procedures, or government documents such as I-9, W-4, and more! If you see this section on your homepage, this means that you have outstanding document signing requests that are to be completed.
To complete your document signing requests, simply click on the link(s) listed. You will be redirected to the document for completion. While navigating through the documents, please ensure that you fill out all required fields, as certain fields must be completed before submission.
# Reset/Change your password
Source: https://docs.roostedhr.com/guides/general/resetchange-your-password
Changing forgotten password in your Roosted worker account.
If you have forgotten or need to change your Roosted password, there are multiple ways to do this. **If a worker has multiple accounts (is working for more than one company) these steps are to be followed, as changing the password from the adminΒ΄s point of view wonΒ΄t be possible.**
* **Forgotten password - Desktop**
Click the **[Password Reset](https://login.roostedhr.com/passwordReset)** **link** **or** **¨forgot password¨** on the login page.
Enter your email address & click submit. A reset link will be sent to your email address provided if there is an account associated.
* **Forgotten password - Mobile App**
The main login page on the mobile app - **Forgot Password?**
Enter your email address & submit.
* **Changing password - Desktop**
Click the profile icon in the top right - View - Edit Profile - NEW PASSWORD.
Input our new password & click OK.
* **Changing your password (Mobile App)**
In the mobile app, tap the hamburger icon (3 lines on the top left) - About Me - Change Password (top right).
Enter the new password & tap ok.
This is how you can reset & change your password on Roosted through the desktop & mobile app! π
# Shift Visibility
Source: https://docs.roostedhr.com/guides/general/shift-visibility
How to configure how far out workers can see open shifts?
In this article, we will explain the Shift visibility feature. Efficient shift management is crucial for maintaining a well-organized and productive workplace. One powerful tool in Roostedβs arsenal is the **Shift Visibility** setting, which allows you to control **how far in advance workers can see available shifts.** This feature helps in balancing the workload and ensuring that shifts are filled based on workers' seniority and experience.
## Key Shift Settings
1. **Hide All Shift Times from Workers:** You can choose to hide all shift times from workers, providing flexibility in how shift information is communicated. This setting can also be adjusted for each shift while editing an event, giving you control over what information is visible on a per-shift basis.
2. **Show Full Location on Available Shifts:** Ensure that workers have all the necessary information by showing the full location details on available shifts. This helps reduce confusion and ensures everyone knows where they need to be.
3. **Worker Self Sign-Up:**
* **Active**: Workers can directly sign up for open shifts or request shifts.
* **Inactive**: Workers cannot directly sign up for or request shifts. Note that this setting does not affect the functionality of the Sign Up Bot, which can still assign shifts automatically.
4. **Manage Worker Visibility with Roosted:**
* **Off**: All workers can see all shifts.
* **On**: Workers will have visibility based on a sliding scale, with senior workers seeing shifts further in advance compared to junior workers. This setting helps manage shift coverage based on experience and reliability.
5. **Customize Minimum Visibility:**
* **Minimum Visibility**: Set the minimum number of days in advance that the lowest-ranked and newest workers can see available shifts. This ensures that even the newest team members have some visibility, allowing them to plan their schedules accordingly.
## Configuring Shift Visibility
To configure shift visibility in Roosted:
1. **Navigate to Settings**: Go to **Configuration** and select **Settings**.
2. **Locate Shift Options**: Within the settings, find the **Shift Options** section.
3. **Adjust Visibility**: Use the sliding scale to set the visibility range for open shifts based on the seniority of your workers.
And this is how you manage your shift's visibility in Roosted!
# Viewing & Submitting Availability (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/viewing-submitting-availability-desktop-mobile-app
How to view & submit availability on both the desktop & mobile app.
In this article, we will explain how to view & submit availability on both the desktop & mobile app.
**Desktop** You can view & submit availability through your **Calendar**. Click on the current day on the calendar or select a day in the future. Click + on the right side of the availability box.
You can start & end time for your availability or select any or all of the following:
Here are the different options you can choose when submitting your availability:
* **All day**: This option covers the entire day.
* **Overnight**: This allows you to set availability that extends into the next day. For example, if you start on Friday, June 2nd, and select Overnight, you will choose an end time for Saturday, June 3rd.
* **Repeating**: This option repeats your availability for the same day(s) in future weeks. For example, if you set a start time of 10:00 AM and an end time of 2:00 PM on Friday, June 3rd, and select Repeating, this will apply to all subsequent Fridays.
Once you have submitted your availability, you can view it from your calendar by selecting the day(s). **View on calendar:**
**View on each day:**
On the calendar, there are symbols that indicate your availability status. By hovering over these symbols, you can see their meanings:
* A **grey calendar with a tick** means you have submitted availability for that day.
* A **yellow calendar with a line through it** means you have no availability submitted for that day.
These symbols help you quickly check your availability status at a glance.
**Mobile App** On the Mobile App main homepage, you can tap the hamburger icon (β°) in the top left to add your availability.
Tap on the date at the top of the page choose ADD and tap AVAILABILITY. You can change the Start & End time, or tap the toggle to the right side to change any of the following:
**All Day** - meaning you are available all day.
**Overnight** - meaning that you are available overnight (i.e into the next day)
**Repeating** - meaning you want to submit this availability for all future weeks based on what you have selected.
You can select all 3 toggles (All Day, Overnight & Repeating) as shown in the picture below. You can swipe the dates right to left on the top of the screen. This allows you to submit availability for the upcoming week. Tap SAVE to save your availability - it will show as a green underline on the date.
Check our video explaining the topic even further!
This is how you can view & submit your availability through Roosted on both the desktop & mobile app! π€
# Worker Profile (Desktop & Mobile App)
Source: https://docs.roostedhr.com/guides/general/worker-profile-desktop-mobile-app
Viewing and editing your personal profile on the Desktop & Mobile App
Through the Desktop, access your worker profile on the top right side by the profile icon - view edit profile.
Here you will see many different sections: **Details**
Here, you can view your profile details, and depending on your company settings, update them. You may also be able to upload a photo. You can also change your password: **NEW PASSWORD** - enter your new password - OK. See **[Reset/Change your password](https://support.roostedhr.com/en/articles/9484360-reset-change-your-password)** for all ways of resetting and changing your password. **Additional** Here you can add your birth date, upload your certificates or licenses, and add their expiration dates.
Your workplace may ask questions such as whether you are willing to drive a carpool or if you have facial hair. To answer these, simply click the dropdown arrow, select your response, and your answer will populate the field.
To upload a file click to add or drag the file from your desktop into the file to upload.
Once you have uploaded, it will appear on the left side of this field.
If you need to replace a file, follow the same process. You can also download and view the document uploaded by clicking the file. **Calendar Sync** You can sync your shifts to your calendar depending on your company settings.
You can easily sync to Apple & Google Calendar in a few clicks. See **[Calendar Sync](https://support.roostedhr.com/en/articles/9490993-calendar-sync-workers)** for more information. **Documents** The documents section will show all uploaded ones if your company allows them to be viewed.
**Mobile App** On your Mobile App, navigate to the Menu in the top left - About Me
Here, you can change any details:phone number, email, profile photo or update information such as any license expiration dates.
You can also change your password by tapping CHANGE PASSWORD in the top right & follow the steps! Check out our Roosted YT video that expands the topic to the fullest:
And this is your worker profile through Roosted! π€
# App Troubleshooting
Source: https://docs.roostedhr.com/guides/mobile/app-troubleshooting
Experiencing problems with your Roosted app?
If you're encountering issues with the Roosted mobile app, consider the following steps:
1. Ensure your app is updated to the latest version.
2. Confirm your phone's software is up-to-date.
**App is up-to-date:** The easiest way to ensure is by enabling auto-app updates through your Android or iOS device. More information can be found on the **[Mobile App](https://support.roostedhr.com/en/articles/9490959-downloading-the-mobile-app)** article. If you decide not to use auto-app updates, you can check if an update is available by going to your App Store or your Google Play Store and searching for Roosted. On the App Store - if there is an available update, you will see UPDATE instead of seeing OPEN (as shown in the below picture)
**Phone software is up-to-date:** To ensure that your device software is up-to-date or to install new updates, it is important to follow these steps: ***Android*** To check if an update is available:
1. Open your deviceβs Settings app.
2. Tap **Security**.
3. Check for an update:
4. To check if a security update is available, tap **Google Security checkup**.
5. To check if a Google Play system update is available, tap **Google Play system update**.
6. Follow any steps on the screen.
***Apple iOS*** At any time, you can check for and install software updates. Go to Settings
> General > Software Update. The screen shows the currently installed version of iOS and whether an update is available. To turn off automatic updates, go to Settings > General > Software Update > Automatic Updates. Automatic software updates can be enabled on both Android & iOS, however, certain updates need to be installed manually.
# Downloading the Mobile App
Source: https://docs.roostedhr.com/guides/mobile/downloading-the-mobile-app
How to download and set up the Roosted app?
Downloading the mobile app couldn't be easier on both Android & Apple devices. The Roosted Mobile App is supported by all smartphones. It can be downloaded from your App Store provider by searching for RoostedHR! Roosted supports iOS 13 & above. Roosted supports Android 8 & above. If you are using the software below or none of those shown above, the app, in some cases, may not work properly or may be very slow. Clicking either of these two links below will re-direct you to your app store so you can download Roosted. **Android** - **[Roosted - Apps on Google Play](https://play.google.com/store/apps/details?id=io.ionic.schedulehead\&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)** **Apple iOS** - **[Roosted on App Store](https://apps.apple.com/us/app/schedulehead/id1308409025?ign-itscg=30200\&ign-itsct=apps_box)** The Roosted app will update from time to time, it is highly recommended to enable auto app updates. Instructions on how to do so are listed below.
## Android
1. Open the Google Play Store app
2. At the top right, tap the profile icon.
3. Tap **Settings**
**Network Preferences**
**Auto-update apps**.
4. Select an option:
5. Over any network to update apps using either Wi-Fi or mobile data.
6. Over Wi-Fi only to update apps only when connected to Wi-Fi.
**Note**: If an account on your device has a sign-in error, apps may not update automatically.
## Apple iOS
Tap Settings - Tap App Store - toggle App Updates on or off based on your preference. If turned on automatic update, your Roosted app are automatically updated via Wi-Fi.
# Payroll Groups
Source: https://docs.roostedhr.com/guides/payroll/payroll-groups
What is a Payroll Group and where can you adjust it?
What are they? Payroll groups are used to assign wage groups, advanced payroll rules, and invoice costs and IDs.
## How does it work?
A payroll group can be assigned to each shift when editing an event.
You can also set up a default payroll group on the skillset.
This allows the payroll group to automatically be assigned when you create a shift. Wage groups, advanced payroll rules, and invoice customizations can be discussed with your Client Success Engineer.
## Do I have to assign a default skillset?
You do not have to assign a default skillset. You can change the assigned payroll group on any shift.
# QuickBooks Support
Source: https://docs.roostedhr.com/guides/payroll/quickbooks-support
Exporting Time Tracking Data to QuickBooks
We support exporting time tracking data to QuickBooks products, including both QuickBooks Desktop (all versions) and QuickBooks Online. This integration requires a one-time nominal hookup fee. Once set up, your data can sync with as little as a single click. To connect your QuickBooks to Roosted, please open a support ticket.
# Wage Types
Source: https://docs.roostedhr.com/guides/payroll/wage-types
What are the types of wages you can use for your workers in Roosted?
What are they? Wage types are how Roosted decides what wage a worker should receive for a shift.
## Where do I assign each worker's wage?
Any admin with permission to view and edit wages can see them by going into the **worker's profile** and clicking on wages. This tab has a breakdown of all wage types displayed.
## Where do I assign them to a shift?
Wage groups are assigned to shifts based on what **[Payroll group](https://support.roostedhr.com/en/articles/9497345-payroll-groups)** has been assigned to the shift. Assigning a wage type to a payroll group is done from the payroll groups module under configuration.
## How do I create them?
These are typically created for you when you create a **[Skillset](https://support.roostedhr.com/en/articles/9491123-skillsets)**. If you need to create them yourself, you can go to wage types under configuration on the side menu, and then click on create type.
## How do I export them?
Wages can be exported on any custom payroll exports or any integration that supports them. If you have any questions, you can always contact your client success engineer.
# Highly rated workers could have a low star ranking
Source: https://docs.roostedhr.com/guides/reviews/highly-rated-workers-could-have-a-low-star-ranking
Why my good workers have low ratings?
**Question:** Why would a great worker have a low star rating?
**Answer:** A worker might have good reviews but still maintain a low star rating due to several factors:
* **Lack of Seniority**: They may not have accumulated enough experience or tenure.
* **Lateness**: Frequent tardiness can negatively impact their rating.
* **No Shows**: Missing scheduled shifts without prior notice affects their rating.
* **Bailouts**: Canceling a shift at the last minute can significantly damage their rating, though the impact varies based on the context.
**For Example:**
* If a worker signs up for a shift two weeks in advance but then realizes they have a prior personal commitment and cancels, Roosted generally will not penalize them.
* However, if a worker cancels just one hour before the shift, it will result in a substantial penalty.
The extent of the penalty depends on how disruptive the bailout is to your shift. **Remember:** The damage from a low rating is not permanent. Workers can improve their star rating by enhancing their performance and reliability.
# Time Off Manager
Source: https://docs.roostedhr.com/guides/time-off/time-off-manager
How to approve or reject Time Off requests of your workers?
**Time Off Manager** provides a comprehensive view of time off requests from your workers. In the main Time Off Manager display, you can easily approve or deny requests and view all Pending, Approved, and Rejected time off requests. To access the Time Off Manager module:
1. Go to the blue Admin bar on the left-hand side.
2. Navigate to **Scheduling**.
3. Select **Time Off Manager**.
Here, you can efficiently manage and review all time off requests categorized as Pending, Approved, or Rejected. From here, we can easily see Pending, Approved & Rejected Time Off Requests
All time off requests will include the following details:
* **Worker's Name**: The individual who submitted the request.
* **Request Type**: What the worker is requesting (e.g., vacation, personal time).
* **Submission Date**: When the request was submitted.
* **Reason**: Any reason or explanation provided by the worker.
## Approving a Time Off Request
Approving a time off request is straightforward: click the tick box next to the request and then select **Approve Request**.
This will move the request from Pending to Approved.
## Rejecting a Time Off Request
Rejecting a time off request is by clicking the X and Reject Request.
This will move the request from Pending to Rejected.
## Approved Time Off Requests
**Approved Time Off Requests** are those that you have approved. They will display the following details:
* **Worker's Name**: The name of the worker who made the request.
* **Coverage Period**: The start and end dates of the approved time off.
* **Approval Date and Time**: When the request was approved.
* **Reason**: Any reason provided by the worker for the time off.
You can also reject an approved time off by clicking the X and Reject Request.
This will move the request from Approved to Rejected.
## Rejected Time Off Requests
**Rejected Time Off Requests** are those that you have declined. They will display the following details:
* **Worker's Name**: The name of the worker who made the request.
* **Coverage Period**: The start and end dates of the rejected time off.
* **Rejection Date and Time**: When the request was rejected.
* **Reason**: Any reason provided by the worker for the time off.
You can also change a rejected request to an approved one by clicking the tick box next to the request and selecting **Accept Request**.
This will move the request from Rejected to Approved. Check out our walk-through video that expands the topic fully!
And that's it! This is how you use the Time Off Manager to approve or reject all time off requests submitted by your workers through Roosted!
# Time Off Requests
Source: https://docs.roostedhr.com/guides/time-off/time-off-requests
Time-off requests are requests a worker can put in letting you know they will not be available to work any shifts. How to manage them?
**Time Off Requests: What Are They?** Time-off requests are submissions made by workers to inform you that they will be unavailable to work during certain shifts. You can easily enable or disable time-off requests by navigating to:
1. **Configuration**
2. **Settings**
3. **Worker Interaction**
4. **Time Off Requests**
From this section, you can toggle Time Off Requests on or off. When enabled, workers can submit their time-off requests. When disabled, they will not be able to make such requests.
## How do they work?
When a worker submits a time off request, they will not be able to pick up any shifts or receive Sign-Up Bot messages for shifts that overlap with their requested time off. As an admin, you can approve or reject this request through the **[Time Off Manager.](https://support.roostedhr.com/en/articles/9497286-time-off-manager)** If the worker withdraws the time off request or if you reject it, **the worker will be eligible to pick up shifts during that time period.**
## How can I approve or deny them?
There are two ways to view, approve, or deny a workerβs time off requests:
1. **Via the Workerβs Profile**:
1. Go to the **Workers Module**.
2. Click the wrench icon to the right of the worker whose time off you want to review.
3. Select **Schedule**.
4. Click on **Availability/Time Off**.
Here, you can view the workerβs time off and availability on a weekly basis. To see the details of a time off request, select the day marked with a time off indicator.
2. **Via the Time Off Manager**:
1. Access the Time Off Manager from the blue Admin bar on the left-hand side under **Scheduling**.
This section provides a centralized view where you can easily approve or deny requests.
From this screen, you can view and reject time off requests. To reject a request:
1. Click the **bin icon** next to the request.
2. Confirm the rejection by clicking **OK**.
## Where can workers add time off requests?
Workers can add time off requests by logging into the web app. From their homepage, they can either:
1. Click on **Go to Calendar**.
2. Access the calendar to add their time off request.
Workers can add time off requests by logging into the web app. From their homepage, they can:
1. Click on **Go to Calendar**.
2. Alternatively, click the **person icon** at the top right and then select **Calendar**.
This will take them to a calendar layout where they can select a day in the future to add time off requests.
βOwners & Admins enter time off in the same two places a worker will add availability.
# Admin Status Removed / Features Disabled / Premium Only
Source: https://docs.roostedhr.com/guides/troubleshooting/admin-status-removed-features-disabled-premium-only
Sudden changes or lack of access on your account? Check this information!
If you notice that your admin access or certain features that were previously enabled on your account are suddenly unavailable, check the status of the company credit card on the Company Info page. **This can be an indication that the credit card on file needs to be updated.** Here are the steps to follow:
1. **Access the Company Info Page:**
Navigate to the Company Info page in your account settings.
2. **Check for Alerts:**
Look for any notifications or alerts on the page. A common indicator of a problem with the credit card is a yellow triangle with an exclamation mark (!).
3. **Update the Credit Card:**
If you see the **yellow triangle,** it means there is an issue with the current credit card. Update the card details to ensure that the payment information is correct and up to date.
4. **Verify Premium Features:**
If you see "Premium Only" messages on the settings page for various features, this is another sign that the **payment information needs to be updated.**
By following these steps and ensuring that your company's credit card information is current, you can restore access to admin privileges and all previously enabled features.
# Closing your account
Source: https://docs.roostedhr.com/guides/troubleshooting/closing-your-account
How to close your Roosted account?
We'd hate to see you go, but if Roosted isn't right for you, please open a support ticket to close your account.
## Before You Go
Have you tried contacting a Client Success Engineer to make sure you're getting the most out of Roosted? Our developer's team can adjust the service to your needs - we can be tailor-made for you! We're happy to help, and unlimited training is complimentary with your subscription. If we may be of assistance email us at [support@roostedhr.com](mailto:support@roostedhr.com)
# Trouble Logging In?
Source: https://docs.roostedhr.com/guides/troubleshooting/trouble-logging-in
Basic troubleshooting to help you solve basic issues.
**Wrong password:** If while logging in you are seeing the issue of an Invalid username or password, try the basic troubleshooting steps explained below. **Solutions:**
* You can visit [https://login.roostedhr.com/passwordReset](https://login.roostedhr.com/passwordReset) to request a new password be sent to your email. If you do not see the email, make sure to check your spam folder.
* You can contact your place of work to have them update your password.
**Error message:** If you cannot log in to your account and you returned directly back to the username and password prompt with an account status error message. **Solutions:**
* Account may still need to be activated: **You should contact your place of work regarding the status of your account.**
* Some old browsers aren't supported: If you're using an old version of Microsoft Internet Explorer, you may experience problems with Roosted. Switch to a modern browser like [Chrome](http://google.com/chrome).
* Cache needs to be cleared: Occasionally, you'll need to empty your browser's cache for Roosted and other websites to function correctly.
**For instructions on clearing your cache, please see the following resource:** [https://kb.iu.edu/d/ahic](https://kb.iu.edu/d/ahic)
# Why Can't a Worker See Certain Shifts?
Source: https://docs.roostedhr.com/guides/troubleshooting/why-cant-a-worker-see-certain-shifts
Who gets to see the shifts first?
Not every worker sees the same view of available shifts in Roosted. The system shows each shift to the workers it deems the best fit first. This means your highest-rated and most senior workers will see shifts before others. If no one signs up, the shift opens up to more staff. **How Roosted Judges** Roosted considers several factors when showing available shifts to a worker:
* **Seniority:** How many shifts has the worker completed?
* **Star Rating:** Higher-rated workers will see shifts before lower-rated ones.
* **Skillset:** The worker must have the necessary skills for the job to appear in their available shifts.
* **Availability:** Ensure the worker has marked themselves as available if using the availability system.
* **Time Off:** Ensure the worker hasn't requested or been approved for time off if using the time off system.
See **[Shift Visibility](https://support.roostedhr.com/en/articles/9681696-shift-visibility)** for more information. It is highly recommended not to use the Availability system as workers need to all have entered the correct availability to see certain shifts. If you discover that no workers can see any shifts, please check your settings in Configuration -> Settings -> Worker Interaction -> Availability
# You see code or error?
Source: https://docs.roostedhr.com/guides/troubleshooting/you-see-code-or-error
Clearing Browsing Data: A Quick Guide to Troubleshooting
If you are experiencing any view issues or seeing errors, it most likely is your browser, browsing data, or cache and cookies files. Clearing browsing data is a simple yet effective troubleshooting step for resolving various issues with web applications and browser performance. Hereβs a brief overview of what it entails and how it can help:
## What is Browsing Data?
Browsing data includes cookies, cached images, and files that your browser stores to improve your web experience. Over time, this data can accumulate and potentially cause issues such as:
* **Slow Performance:** Accumulated cache and cookies can slow down your browser.
* **Login Problems:** Corrupted cookies can interfere with login sessions and preferences.
* **Page Loading Issues:** Outdated or corrupted cache can prevent pages from loading correctly.
## How Clearing Browsing Data Helps
1. **Improves Performance:** Removing cached files and cookies frees up space and can speed up your browser.
2. **Resolves Login Issues:** Clearing cookies can fix problems related to logging in or accessing specific sites.
3. **Fixes Page Errors:** Clearing outdated or corrupted cache can resolve issues with pages not displaying correctly.
## How to Clear Browsing Data
Here's a quick guide for clearing browsing data in popular browsers:
* **Google Chrome:**
1. Click the three-dot menu in the top-right corner.
2. Go to **More Tools** > **Clear Browsing Data**.
3. Choose the data types you want to clear (e.g., Cookies, Cached images).
4. Select the time range and click **Clear Data**.
* **Mozilla Firefox:**
1. Click the three-line menu in the top-right corner.
2. Go to **Settings** > **Privacy & Security**.
3. Under **Cookies and Site Data**, click **Clear Data**.
4. Select the data types and click **Clear**.
* **Apple Safari:**
1. Go to **Safari** > **Preferences**.
2. Click on **Privacy** > **Manage Website Data**.
3. Click **Remove All** to clear data.
By regularly clearing your browsing data, you can help maintain optimal performance and resolve common issues. If you encounter problems with a web application or your browser seems sluggish, try this troubleshooting step to see if it resolves the issue. If that does not solve the issue, please contact your Client Support Specialist or open a support ticket and we will look into it quickly look into it.
# Worker Calendar
Source: https://docs.roostedhr.com/guides/worker-help/worker-calendar
How does the calendar look from workers side?
In this article, we will discuss how the worker calendar can be used for workers to:
1. **View/Submit Availability**
2. **View/submit time off requests**
3. **View/submit time punches**
4. **View/submit reimbursements**
You can view your calendar from your Roosted homepage. To access the calendar, simply click **Go to Calendar** on the homepage.
Or click the profile icon in the top right & Calendar.
You will see your calendar like below:
## View/Submit Availability
Click on the current day on the calendar or select a day in the future, scroll down to the bottom of the page & click + on the right side of the availability box.
Add start & end time for your availability and select any or all of the following:
* **All day** - entire day availability
* **Overnight** - the current day and throughout the night
* **Repeating** - this will add this availability to all the following days - if Thursday, Dec 2nd from 9 am - 5 pm & will be set available / Repeating - this availability will apply to all following Thursdays. Once you have submitted your availability, view it from your calendar or select the day: **Calendar view:**
### View on Each Day
Symbols on the calendar provide additional information when you hover over them:
* A grey calendar with a tick indicates that you have submitted availability for that day.
* A yellow calendar with a line through it indicates that you have not submitted availability for that day.
## View/Submit Time Off Requests
To submit time off requests, click on the current day, or any future day. Click the + on the right side of the Time Off section.
Select a start date and time, an end date and time, and optionally provide a reason. Management will be able to view this reason when reviewing your time off requests.
Once the time off request is added, a grey plane symbol will show on the dates. Your time off will be pending for approval.
If your time off has been approved, the above will change from Pending to Approved.
If your time off has been rejected, the submitted time off request will be removed from your calendar.
## View/Submit Time Punches
Select and add time punches for the current day or a past day - these will be submitted for approval to your management team. To add a time punch, select the day, scroll down, and click the **+** next to **Time Punches**. On the next screen, enter the time and click **Add**.
This will then appear as a Pending time punch:
A grey clock symbol indicates that there are time punches added to that day. When you have submitted a time punch, yet to be approved or rejected, it can be edited or deleted - click the wrench to the right side and adjust or delete your time punch.
If you delete a time punch, it will become a **Pending Delete** time punch, meaning your management team must approve the deletion. If your time punch is approved, its status will change from **Pending** to **Approved**. If it is rejected, it will be removed from your calendar. If the **+** symbol is not available, it may be because you have selected a day in the future or your company has disabled this feature.
## View/Submit Reimbursements
If your company allows reimbursements to be submitted, click the day & at the bottom click the + on the right side of where it says Reimbursements.
There are 2 different types of reimbursements, standard & mileage
### Standard
An amount-based reimbursement, such as for parking expenses. If you select Standard, enter the reimbursement amount in the **Amount** field, add an optional comment, and upload a receipt picture. Depending on your company settings, uploading a receipt picture may be mandatory before the reimbursement can be submitted.
### Mileage
Used if your company reimburses based on distance. To use this option, select **Mileage** and enter the number of miles covered. Depending on your company settings, it may be mandatory to submit a mileage picture/map.
## General Reimbursement Information
Once you have added your reimbursement, it will appear as pending on your calendar, awaiting approval from your management team.
Submitted reimbursements will appear as a grey icon on the day.
Before the reimbursement is approved or rejected, you can delete it by clicking the trash can on the right side. If the reimbursement has been rejected, it will appear as shown below.
And if this has been approved, it will show as below.
And this is how you can use your calendar through Roosted! π€
# Convert Candidate to Worker
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/convert-candidate-to-worker
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/convert-to-worker
This action is irreversible. Once a candidate is converted to a worker, they cannot be reverted to candidate status.
# Create Candidate
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-candidate
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates
# Create Candidate Note
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-candidate-note
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/notes
# Create Custom Field
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/create-settings-custom-field
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-settings/custom-fields
# Delete Custom Field
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/delete-settings-custom-field
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /ats-settings/custom-fields/{id}
# Update ATS Configuration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-settings-config
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-settings/config
This endpoint can toggle the `active` flag, which enables or disables the entire ATS module for your company. Use with caution.
# Update Custom Field
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/edit-settings-custom-field
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /ats-settings/custom-fields/{id}
# Get Candidate
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}
# Get Candidate Activity
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-activity
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/activity
# List Candidate Applications
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-applications
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/applications
Cursor-paginated. Use `cursor` and `limit` (default 25, max 100) to navigate results.
# List Applied Contracts
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-applied-contracts
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/applied-contracts
# Get Compliance Gaps
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-compliance-gaps
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/compliance-gaps
Cursor-paginated. Use `cursor` (opaque string from `next_cursor`) and `limit` (default 25, max 100) to navigate results. `next_cursor` is `null` when no more pages exist.
# Get Candidate Messages
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-messages
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/messages/{application_id}
This endpoint does not trigger notifications β integrators manage their own notification flows. Reading messages automatically marks them as read.
# List Candidate Notes
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidate-notes
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates/{id}/notes
# List Candidates
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-candidates
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-candidates
Paginated. Use `page` (default 1) and `items_per_page` (max 100) to navigate results.
# Get Audit Log
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-dashboard-audit-log
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/audit-log
Cursor-paginated. Use `cursor` and `limit` (default 25, max 100) to navigate results.
# List Audit Log Accessors
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-dashboard-audit-log-accessors
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/audit-log/accessors
# Get Dashboard Badges
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-dashboard-badges
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/badges
# Get Pipeline Summary
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-dashboard-pipeline-summary
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-dashboard/pipeline-summary
# Get ATS Configuration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-settings-config
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-settings/config
# List Custom Fields
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/get-settings-custom-fields
api-reference/v01.12.00/openapi-v01.12.00.json GET /ats-settings/custom-fields
# Import Worker as Candidate
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/import-candidate
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/import
Import an existing worker into the ATS as a candidate. Optionally provide `contract_id` to auto-create an application.
# Resend Candidate Invitation
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/resend-candidate-invitation
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/resend-invitation
# Review Credential
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/review-credential
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-credentials/{id}/review
# Send Candidate Message
Source: https://docs.roostedhr.com/api-reference/v01.12.00/ats/send-candidate-message
api-reference/v01.12.00/openapi-v01.12.00.json POST /ats-candidates/{id}/messages/{application_id}
This endpoint does not trigger notifications β integrators manage their own notification flows.
# Approve Client Order
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/approve-client-order
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/orders/{order_id}/approve
Approves a pending client portal order. Only orders with status `0` (pending) can be approved.
Only orders with a **pending** status (`order_status: 0`) can be approved. Attempting to approve an order in any other status will return a `400` error.
# Create Client
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients
Creates a new client. Only `client_name` is required.
`client_name` is the only required field. All other fields are optional and can be set later via the [Edit Client](/api-reference/v01.12.00/clients/edit-client) endpoint.
After creating a client, use the [Invite Client](/api-reference/v01.12.00/clients/invite-client) endpoint to send them a client portal invitation email.
# Create Client Contact
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client-contact
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/contacts
Creates a new contact for a specific client.
# Create Client Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client-rule
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/rules
Creates a new worker matching rule for a specific client. Rules filter which workers are eligible for this client's events based on custom field values, credentials, and tags.
Rules filter which workers are eligible for this client's events. A rule is defined by a `field_id` (referencing a worker custom field) and an `operator` (`is`, `is not`, etc.).
The response includes the full rule structure with resolved field names, credentials, and tags:
* **`fields`** β Custom field conditions (e.g., "Facial Hair is Yes").
* **`credentials`** β Credential requirements (e.g., "has Completion certificate").
* **`has_tags`** β Workers must have these tags.
* **`does_not_have_tags`** β Workers must not have these tags.
# Decline Client Order
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/decline-client-order
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/orders/{order_id}/decline
Declines a pending client portal order. Only orders with status `0` (pending) can be declined.
Only orders with a **pending** status (`order_status: 0`) can be declined. Attempting to decline an order in any other status will return a `400` error.
# Delete Client
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}
Permanently deletes a client by ID.
# Delete Client Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client-document
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}/documents/{document_id}
Permanently deletes a client document.
# Delete Client Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client-rule
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /clients/{id}/rules/{rule_id}
Deletes a specific worker matching rule from a client.
# Edit Client
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}
Updates an existing client. The `client_name` field is required on every request.
`client_name` is required on every PATCH request, even if you are only updating other fields.
# Edit Client Contact
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client-contact
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}/contacts/{contact_id}
Updates an existing client contact.
# Edit Client Worker Status
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client-worker-status
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /clients/{id}/workers/{worker_id}/status
Updates a worker's preference status for this client.
The three status values are:
* **`preferred`** β Worker gets priority when scheduling this client's events.
* **`normal`** β Default status; worker is eligible but not prioritized.
* **`banned`** β Worker is excluded from this client's events.
# Get Client
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}
Returns a single client by ID.
# Get Client Contact
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-contact
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/contacts/{contact_id}
Returns a single contact by ID.
# Get Client Contacts
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-contacts
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/contacts
Returns all contacts for a specific client.
# Get Client Custom Fields with Values
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-custom-fields
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/custom-fields
Returns all custom fields and their values for a specific client.
# Get Client Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-document
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/documents/{document_id}
Returns a single document by ID.
# Get Client Documents
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-documents
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/documents
Returns all documents uploaded for a specific client.
# Get Client Order
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-order
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/orders/{order_id}
Returns a single client portal order by ID.
# Get Client Orders
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-orders
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/orders
Returns a paginated list of orders submitted through the client portal for a specific client.
# Get Client Rules
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-rules
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/rules
Returns all worker matching rules for a specific client, grouped by category (fields, credentials, has_tags, does_not_have_tags).
# Get Client Worker Status
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-worker-status
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/workers/{worker_id}/status
Returns the preference status of a specific worker for this client.
# Get Client Workers
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-workers
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients/{id}/workers
Returns all workers grouped by their preference status (preferred, normal, banned) for a specific client.
The response groups all company workers into three arrays by their preference status for this client: `preferred`, `normal`, and `banned`.
# Get Clients
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-clients
api-reference/v01.12.00/openapi-v01.12.00.json GET /clients
Returns a paginated list of all clients for your company.
Results are paginated. Use the `items_per_page` parameter (1β100) and `page` parameter to navigate. The response includes a `total_count` field indicating the total number of clients.
# Invite Client by Email
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/invite-client
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/invite
Sends a client portal invitation email to the client's primary contact email address. No request body is needed.
No request body is needed. The invitation is sent to the client's existing `client_contact_email` address. Make sure this field is set before calling this endpoint.
# Set Client Custom Field Value
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/set-client-custom-field
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/custom-fields
Sets a value on an existing company-wide custom field for a specific client. This does not create a new field definition.
This endpoint **sets a value** on an existing company-wide custom field for a specific client β it does not create a new field definition. Custom field definitions are managed at the company level.
# Upload Client Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/clients/upload-client-document
api-reference/v01.12.00/openapi-v01.12.00.json POST /clients/{id}/documents
Uploads a document for a specific client. Maximum file size is 50 MB.
Upload files using `multipart/form-data` encoding. The maximum file size is **50 MB**.
# Create Company Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/create-company-document
api-reference/v01.12.00/openapi-v01.12.00.json POST /company/documents
This endpoint serves the purpose of creating a company document.
The request body should be sent as `application/json` with the file content as a binary string. All four fields (`name`, `file`, `type`, `file_name`) are required.
# Delete Company Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/delete-company-document
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /company/documents/{id}
This endpoint serves the purpose of deleting company document based on unique document ID.
This performs a soft delete β the document is marked as deleted but retained in the system. The `deleted` flag is set to `1` and `date_deleted` is recorded.
# Delete Company Integration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/delete-company-integration
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /company/integrations/{id}
This endpoint serves the purpose of deleting a company integration.
# Edit Company Info
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/edit-company-info
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /company/info
This endpoint serves the purpose of modifying company information.
All fields are optional β only include the fields you want to update. Omitted fields remain unchanged.
# Get Company Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-document
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/documents/{id}
This endpoint serves the purpose of fetching company document based on unique document ID.
# Get Company Documents
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-documents
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/documents
This endpoint serves the purpose of fetching company documents.
# Get Company HR Info
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-hr-info
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/info/hr
This endpoint serves the purpose of fetching company HR information.
Returns an array of the company's HR contacts. Each contact includes the manager name, email, phone number, and whether they are the default HR contact.
# Get Company Info
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-info
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/info
This endpoint serves the purpose of fetching company information.
This endpoint returns general company profile information including name, contact details, and address.
For HR contact details, use the [Get Company HR Info](/api-reference/v01.12.00/company/get-company-hr-info) endpoint.
# Get Company Integration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integration
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations/{id}
This endpoint serves the purpose of fetching company integration based on unique integration ID.
# Get Company Integrations
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integrations
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations
This endpoint serves the purpose of fetching company integrations.
# Get Company Integrations Count
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integrations-count
api-reference/v01.12.00/openapi-v01.12.00.json GET /company/integrations/count
This endpoint serves the purpose of fetching total count of company integrations.
# Regenerate Company Integration Secret Key
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/regenerate-company-integration
api-reference/v01.12.00/openapi-v01.12.00.json POST /company/integrations/{id}/regenerate
This endpoint serves the purpose of regenerating the secret key for a company integration.
# Set Up Company Integration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/set-up-company-integration
api-reference/v01.12.00/openapi-v01.12.00.json POST /company/integrations
This endpoint serves the purpose of setting up a new company integration with a partner.
# Update Company Integration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/company/update-company-integration
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /company/integrations/{id}
This endpoint serves the purpose of updating a company integration's configuration.
# Edit Configuration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/configuration/edit-configuration
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /config
Updates a single configuration setting. Settings are identified by their category, subcategory, and item name.
Updates a single setting using an addressing pattern of `category > subcategory > item > value`. The response returns only the updated value, not the full configuration object.
### Valid categories and subcategories
| Category | Subcategories |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `shift_options` | `shift_requests`, `split_shifts`, `shift_equalizer`, `shift_visibility`, `worker_limits` |
| `worker_interaction` | `bailouts`, `availability`, `time_off`, `reviews_and_stars`, `blogs`, `coworker_display`, `calendar_sync` |
| `worker_communication` | `autotext`, `web_checkin`, `silence_mode`, `text_communication`, `custom_messages`, `invite_to_work`, `event_updates` |
| `admin` | `daily_summary`, `verbose_emails`, `list_view_options`, `list_view_verbose`, `worker_profile_control`, `publish_system`, `bailout_reason` |
| `time_tracking` | `time_tracking`, `show_workers_hours`, `client_sign`, `reimbursements`, `deductions`, `personnel_orderables` |
Boolean settings must be sent as `true` / `false`, not `1` / `0`. Some settings depend on the company's premium subscription status and will return an error if the feature is not available.
Use `GET /config` first to discover the available items within each subcategory and their current values.
# Get Configuration
Source: https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-configuration
api-reference/v01.12.00/openapi-v01.12.00.json GET /config
Returns all configuration settings for your company, organized into five categories: shift options, worker interaction, worker communication, admin, and time tracking.
Returns all configuration settings for your company. The response is organized into five top-level categories, each containing subcategories of individual settings.
| Category | Description | Subcategories |
| ---------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `shift_options` | Shift behavior and limits | `shift_requests`, `split_shifts`, `shift_equalizer`, `shift_visibility`, `worker_limits` |
| `worker_interaction` | Worker-facing features | `bailouts`, `availability`, `time_off`, `reviews_and_stars`, `blogs`, `coworker_display`, `calendar_sync` |
| `worker_communication` | Automated messaging | `autotext`, `web_checkin`, `silence_mode`, `text_communication`, `custom_messages`, `invite_to_work`, `event_updates` |
| `admin` | Admin tools and display | `daily_summary`, `verbose_emails`, `list_view_options`, `list_view_verbose`, `worker_profile_control`, `publish_system`, `bailout_reason` |
| `time_tracking` | Time punch and payroll | `time_tracking`, `show_workers_hours`, `client_sign`, `reimbursements`, `deductions`, `personnel_orders` |
The top-level `premium` boolean indicates whether the company has premium features enabled. The `personnel_orders` subcategory contains the list of orderable items used by the [Create Worker Order](/api-reference/v01.12.00/workers/create-worker-order) endpoint.
# Get Countries
Source: https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-countries
api-reference/v01.12.00/openapi-v01.12.00.json GET /countries
Returns all available countries. Use the country `id` when setting a worker's `country_id`.
Use the country `id` from this response when setting a worker's `country_id` via [Create Worker](/api-reference/v01.12.00/workers/create-worker) or [Edit Worker](/api-reference/v01.12.00/workers/edit-worker).
# Get Timezones
Source: https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-timezones
api-reference/v01.12.00/openapi-v01.12.00.json GET /timezones
Returns all available timezones. Use the timezone `id` when setting a company or location timezone.
Use the timezone `id` from this response when setting a company or location timezone.
# Add Event Admin
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/add-event-admin
api-reference/v01.12.00/openapi-v01.12.00.json POST /events/{id}/admins
Assigns an admin to an event.
The `personnel_id` must reference an existing admin user in your company. Use the company personnel endpoints to look up valid IDs.
# Check if Shift is Full
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/check-shift-full
api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts/{shift_id}/is-full
Checks whether a shift has reached its staffing capacity.
Returns a plain `true` or `false` boolean β not wrapped in an object. A shift is full when `filled` equals `quantity`.
# Create Event
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/create-event
api-reference/v01.12.00/openapi-v01.12.00.json POST /events
Creates a new event.
## Location
Provide the event location via the `location` object. To link an existing saved location, pass `location_id`. To create an inline location, provide `name`, `address`, `city`, and `zip` β set `saved` to `"1"` to save it for reuse.
## Custom fields
Send custom fields as an array of `{ field_id, value }` objects, where `field_id` is the custom field's ID.
## Areas
Assign areas to the event by passing an array of area IDs in the `areas` field. Invalid IDs return a `400` error.
The `client_id` field is optional. When provided, it links the event to an existing client record.
# Create Shift
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/create-shift
api-reference/v01.12.00/openapi-v01.12.00.json POST /events/{id}/shifts
Creates a new shift for an event.
## Skillset
Every shift requires a skillset. Provide `skillset_id` to assign an existing skillset to the shift.
Times use `YYYY-MM-DD HH:MM:SS` format (e.g., `"2025-06-15 09:00:00"`). The shift date portion should match the parent event's date.
# Delete Event Admin
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/delete-event-admin
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /events/{id}/admins/{admin_id}
Removes an admin from an event.
# Delete Shift
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/delete-shift
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /events/{id}/shifts/{shift_id}
Deletes a shift from an event.
# Edit Event
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}
Updates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.
Even though this is a PATCH endpoint, `name`, `date`, and `location` are required in every request. Omitting them returns a validation error.
## Areas
Use the `areas` field to control area assignments. Omit it to leave the event's areas unchanged. Send an empty array (`[]`) to clear all areas. Send a non-empty array of area IDs to replace the current set. Invalid IDs return a `400` error.
# Edit Shift
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-shift
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /events/{id}/shifts/{shift_id}
Updates an existing shift. Only include the fields you want to change.
All fields are optional on edit. Only the fields you include will be updated.
# Get Event
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/get-event
api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}
Returns details for a single event by ID.
# Get Event Admins
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/get-event-admins
api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/admins
Returns the list of admins assigned to an event.
Returns the list of admins assigned to the event. Admins can manage shifts, staffing, and time tracking for their assigned events.
# Get Events
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/get-events
api-reference/v01.12.00/openapi-v01.12.00.json GET /events
Returns a paginated list of events for your company.
Paginated. Defaults to page 1 with 25 items per page. Use `items_per_page` (max 100) and `page` to navigate results.
# Get Shift
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/get-shift
api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts/{shift_id}
Returns details for a single shift by ID.
# Get Event Shifts
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/get-shifts
api-reference/v01.12.00/openapi-v01.12.00.json GET /events/{id}/shifts
Returns all shifts for an event.
# Search Events
Source: https://docs.roostedhr.com/api-reference/v01.12.00/events/search-events
api-reference/v01.12.00/openapi-v01.12.00.json POST /events/search
Searches events using a combination of filters. Returns paginated results.
Searches events using a combination of filters. The response is paginated β use `items_per_page` and `page` query parameters.
`start_date` is the only required filter. All other filters are optional and combine with AND logic β only events matching every provided filter are returned.
Use the boolean filters (`unfilled`, `unpublished_shifts`, `pending_invites`) to surface events needing attention.
# Create Location
Source: https://docs.roostedhr.com/api-reference/v01.12.00/locations/create-location
api-reference/v01.12.00/openapi-v01.12.00.json POST /locations
Creates a new location.
The `location`, `address`, `city`, `zip`, and `timezone_id` fields are required. All other fields are optional.
Use the `default_areas` field to associate areas with the location at creation time. Area IDs can be retrieved from the [Get Areas](/api-reference/v01.12.00/areas/get-areas) endpoint.
# Delete Location
Source: https://docs.roostedhr.com/api-reference/v01.12.00/locations/delete-location
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /locations/{id}
Permanently deletes a location.
This performs a soft delete β the location will no longer appear in listings but associated events and shifts are not affected.
# Edit Location
Source: https://docs.roostedhr.com/api-reference/v01.12.00/locations/edit-location
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /locations/{id}
Updates an existing location. Only include fields you want to change.
This is a partial update endpoint β only include the fields you want to change. Omitted fields remain unchanged.
# Get Location
Source: https://docs.roostedhr.com/api-reference/v01.12.00/locations/get-location
api-reference/v01.12.00/openapi-v01.12.00.json GET /locations/{id}
Returns a single location by ID.
# Get Locations
Source: https://docs.roostedhr.com/api-reference/v01.12.00/locations/get-locations
api-reference/v01.12.00/openapi-v01.12.00.json GET /locations
Returns a paginated list of all locations.
This endpoint returns paginated results. Use `items_per_page` and `page` query parameters to control pagination. The response includes a `total` field with the full count of locations.
# Create Payroll Group
Source: https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/create-payroll-group
api-reference/v01.12.00/openapi-v01.12.00.json POST /payroll-groups
Creates a new payroll group.
Only `name` is required. All other fields are optional and will use system defaults if omitted.
Set `locationAll` to `true` to apply this payroll group to all locations. When `false`, specify individual locations in the `locations` array.
# Delete Payroll Group
Source: https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/delete-payroll-group
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /payroll-groups/{id}
Soft-deletes a payroll group. The payroll group will no longer appear in listings but existing shifts are not affected.
This performs a soft delete β the payroll group will no longer appear in listings but existing shifts assigned to this payroll group are not affected.
# Edit Payroll Group
Source: https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/edit-payroll-group
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /payroll-groups/{id}
Updates an existing payroll group. All fields (name, group_rows, locations) are required in the request body.
This is a partial update endpoint β only include the fields you want to change. Omitted fields remain unchanged.
# Get Payroll Group
Source: https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/get-payroll-group
api-reference/v01.12.00/openapi-v01.12.00.json GET /payroll-groups/{id}
Returns a single payroll group by ID.
# Get Payroll Groups
Source: https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/get-payroll-groups
api-reference/v01.12.00/openapi-v01.12.00.json GET /payroll-groups
Returns all payroll groups, sorted alphabetically by name.
This endpoint returns paginated results. Use `items_per_page` and `page` query parameters to control pagination. The response includes a `total` field with the full count of payroll groups.
# Create Rate Card
Source: https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/create-rate-card
api-reference/v01.12.00/openapi-v01.12.00.json POST /rate-cards
Creates a new rate card with per-skillset billing and pay rate configuration.
Both `name` and `skillsets` are required. The `skillsets` array defines per-skillset billing and pay rates for the new rate card. Each entry maps to a skillset in your company.
Set `hourly_type` to `"shift"` for flat shift-based rates, or `"hourly"` (default) for time-based rates with optional overtime and double-time cutoffs.
# Delete Rate Card
Source: https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/delete-rate-card
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /rate-cards/{id}
Soft-deletes a rate card. The rate card will no longer appear in listings but existing shifts assigned to this rate card are not affected.
This performs a soft delete β the rate card will no longer appear in listings but existing shifts assigned to this rate card are not affected.
# Edit Rate Card
Source: https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/edit-rate-card
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /rate-cards/{id}
Updates rate card billing and pay configuration. Does not allow renaming the rate card.
This endpoint updates rate configuration only β you cannot rename the rate card. Updatable fields: `billing_rate`, `pay_rate`, `hourly_type`, `daily_overtime_cutoff`, `daily_doubletime_cutoff`, and `selected_payroll_rules`.
# Get Rate Card
Source: https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/get-rate-card
api-reference/v01.12.00/openapi-v01.12.00.json GET /rate-cards/{id}
Returns a single rate card entry by ID.
# Get Rate Cards
Source: https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/get-rate-cards
api-reference/v01.12.00/openapi-v01.12.00.json GET /rate-cards
Returns all rate cards with their per-skillset billing and pay rate configuration.
This endpoint returns all rate cards with their per-skillset billing and pay rate configuration. Each entry represents a rate cardβskillset combination with its associated rates and payroll rules.
# Create Skillset
Source: https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/create-skillset
api-reference/v01.12.00/openapi-v01.12.00.json POST /skillsets
Creates a new skillset.
Only `role_title` is required. All other fields are optional and will use system defaults if omitted.
Set `on_for_new_signups` to `1` to automatically assign this skillset to all new workers when they sign up.
# Get Skillsets
Source: https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/get-skillsets
api-reference/v01.12.00/openapi-v01.12.00.json GET /skillsets
Returns a paginated list of all skillsets.
This endpoint returns paginated results. Use `items_per_page` and `page` query parameters to control pagination. The response includes a `total` field with the full count of skillsets.
# Delete Skillset
Source: https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/delete-skillset
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /skillsets/{id}
Soft-deletes a skillset. The skillset will no longer appear in listings but existing shifts are not affected.
This performs a soft delete β the skillset will no longer appear in listings but existing shifts assigned to this skillset are not affected.
# Edit Skillset
Source: https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/edit-skillset
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /skillsets/{id}
Updates an existing skillset. Only include fields you want to change.
This is a partial update endpoint β only include the fields you want to change. Omitted fields remain unchanged.
# Get Skillset
Source: https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/get-skillset
api-reference/v01.12.00/openapi-v01.12.00.json GET /skillsets/{id}
Returns a single skillset by ID.
# Get Worker Time Tracking Summary
Source: https://docs.roostedhr.com/api-reference/v01.12.00/time-tracking/get-worker-time-tracking-summary
api-reference/v01.12.00/openapi-v01.12.00.json GET /time-tracking/worker-summary
This endpoint serves the purpose of fetching worker time tracking summary based on unique worker UUID and date.
This endpoint returns a weekly breakdown of a worker's time tracking data for the pay period containing the specified `date`. The response includes daily punch records, per-day stats (regular, overtime, and double-time hours), and aggregated `week_stats` and `pay_period_stats` summaries.
The `week` object uses dynamic `YYYY-MM-DD` date keys β one entry per day in the week. Use the `keyArray` field to iterate over days in order.
# Create Wage Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/create-wage-rule
api-reference/v01.12.00/openapi-v01.12.00.json POST /wage-rules
Creates a new wage rule.
# Delete Wage Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/delete-wage-rule
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /wage-rules/{id}
Permanently deletes a wage rule.
# Edit Wage Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/edit-wage-rule
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /wage-rules/{id}
Updates an existing wage rule.
# Get Wage Rule
Source: https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/get-wage-rule
api-reference/v01.12.00/openapi-v01.12.00.json GET /wage-rules/{id}
Returns a single wage rule by ID.
# Get Wage Rules
Source: https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/get-wage-rules
api-reference/v01.12.00/openapi-v01.12.00.json GET /wage-rules
Returns all wage rules for your company.
# Add Transferred Workers
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-transferred-workers
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/transferred-workers
Transfers a batch of workers (up to 100) into the company. Each worker must include at minimum `name_first`, `name_last`, and `email`.
# Add Worker Reimbursement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-reimbursement
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements
Add a reimbursement record for a worker.
# Add Worker Tag
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-tag
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/tags/{tag_id}
Adds an existing tag to a worker.
This endpoint assigns an **existing** tag to a worker. To create a new tag, use the [Create Worker Tag](/api-reference/v01.12.00/workers/create-worker-tag) endpoint instead.
# Add Worker Time Punch
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-time-punch
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/time-punches
Add a time punch for a worker.
# Approve Worker Reimbursement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/approve-worker-reimbursement
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements/{reimbursement_id}/approve
Approve a pending worker reimbursement.
# Approve Worker Time Punch
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/approve-worker-time-punch
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/time-punches/{punch_id}/approve
Approve a pending worker time punch.
# Create Chat
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-chat
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/chats
Creates a new chat for a worker.
# Create Worker
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers
Creates a new worker profile. Only the worker name is required β all other fields are optional.
Only `name_first` is required. The `email` and `phone` fields are recommended β they enable account activation emails and SMS notifications respectively.
If `country_id` is omitted, the worker defaults to **United States**. Use the [GET /countries](/api-reference/v01.12.00/configuration/get-countries) endpoint to look up valid country identifiers.
# Create Worker Credential
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-credential
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/credentials
Creates a credential record for a specific worker.
# Create Worker Order
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-order
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/orders
Creates an order for a specific worker. The `id` in the request body refers to the orderable item ID from configuration, and `p_id` is the worker's personnel ID.
The `id` in the request body refers to an orderable item configured under `time_tracking.personnel_orderables` in [GET /config](/api-reference/v01.12.00/configuration/get-configuration).
# Create Worker Tag
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-tag
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/tags
Creates a new global tag and assigns it to the specified worker. The tag becomes available to assign to any worker.
This endpoint creates a **new global tag** and assigns it to the specified worker. Once created, the tag is available to assign to any worker via the [Add Worker Tag](/api-reference/v01.12.00/workers/add-worker-tag) endpoint.
# Delete Chat
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-chat
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/chats/{chat_id}
Deletes a chat by worker ID and chat ID.
# Delete Worker Credential
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-credential
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/credentials/{credentials_id}
Soft-deletes a worker credential. The credential is marked as deleted but not permanently removed.
# Delete Worker Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-document
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/documents/{document_id}
Soft-deletes a worker document. The document is marked as deleted but not permanently removed.
This performs a **soft delete**. The document is marked as deleted (`deleted: "1"`) but not permanently removed. The `date_deleted` field is set to the deletion timestamp.
# Delete Worker Tag
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-tag
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/tags/{tag_id}
Removes a tag from a worker. Returns true on successful deletion.
# Delete Worker Time Punch
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-time-punch
api-reference/v01.12.00/openapi-v01.12.00.json DELETE /workers/{id}/time-punches/{punch_id}
Delete a worker time punch.
# Edit Chat
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-chat
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/chats/{chat_id}
Updates a chat's name or members.
# Edit Worker
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}
Updates an existing worker profile. Only include the fields you want to change β all fields are optional.
This is a partial update β only include the fields you want to change. Omitted fields remain unchanged.
# Edit Worker Permissions
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker-permissions
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/permissions
Updates granular permission flags for a specific worker. Only include the permissions you want to change β omitted permissions remain unchanged. The `admin` and `owner` flags cannot be modified through this endpoint.
This is a partial update β only include the permissions you want to change. Omitted permissions remain unchanged.
The `admin` and `owner` flags cannot be modified through this endpoint. Only the granular permissions within the `permissions` object are updatable.
# Edit Worker Time Punch
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker-time-punch
api-reference/v01.12.00/openapi-v01.12.00.json PATCH /workers/{id}/time-punches/{punch_id}
Update a worker time punch.
# Get Chat
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chat
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/{chat_id}
Retrieves a specific chat by worker ID and chat ID.
# Get Chat Messages
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chat-messages
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/{chat_id}/messages
Retrieves a paginated list of messages in a chat. Supports cursor-based pagination for infinite scroll.
This endpoint uses cursor-based pagination for infinite scroll. Pass `last_seen_id` with the ID of the last message from the previous page to fetch the next set of results. Omit it for the first page.
# Get Chats
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chats
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats
Retrieves a paginated list of active chats for a worker. Supports cursor-based pagination for infinite scroll.
This endpoint uses cursor-based pagination for infinite scroll. Pass `last_seen_id` with the ID of the last chat from the previous page to fetch the next set of results. Omit it for the first page.
Use `search_term` to filter chats by title, or set `all_chats` to `true` to include inactive chats.
# Get Transferred Workers
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-transferred-workers
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/transferred-workers
Returns all transferred workers for the authenticated company.
# Get Unread Messages Count
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-unread-messages-count
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/chats/unread-messages-count
Retrieves the total unread messages count across all chats for a worker.
# Get Worker
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}
Returns the full profile for a single worker by their unique ID.
The response includes the full worker profile β personal info, status flags, assigned areas, and skillsets. Fields like `timezone` and `country` are returned as objects with `id` and `name`, not bare identifiers.
# Get Worker Availability
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-availability
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/availability
Returns availability entries for a specific worker from today forward.
# Get Worker Credential
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-credential
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/credentials/{credentials_id}
Returns a single credential record for a specific worker.
# Get Worker Credentials
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-credentials
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/credentials
Returns a paginated list of credentials for a specific worker. Optionally filter by credential type.
# Get Worker Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-document
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/documents/{document_id}
Returns a single document for a specific worker.
# Get Worker Documents
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-documents
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/documents
Returns all documents uploaded for a specific worker.
# Get Worker Limits
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-limits
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/limits
Returns the shift and hour limits configured for a specific worker.
Both limit fields return `null` when no limit has been configured for the worker.
# Get Worker Order
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-order
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/orders/{order_id}
Returns a single order for a specific worker.
# Get Worker Orders
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-orders
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/orders
Returns a paginated list of orders for a specific worker.
This endpoint is paginated. Use `items_per_page` and `page` query parameters to control results.
# Get Worker Permissions
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-permissions
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/permissions
Returns the permission flags for a specific worker, including admin/owner status and granular module-level permissions.
All permission values are `1` (enabled) or `0` (disabled). The `admin` and `owner` flags are top-level β granular permissions are nested under the `permissions` object.
# Get Worker Reimbursement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-reimbursement
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/reimbursements/{reimbursement_id}
Returns a single reimbursement record for a worker.
# Get Worker Reimbursements
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-reimbursements
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/reimbursements
Returns a paginated list of reimbursements for a worker.
Use the `status` filter to retrieve reimbursements by their processing state:
* `0` β Pending
* `2` β Approved
* `86` β Rejected
Results are paginated. Use `items_per_page` and `page` to navigate through large result sets.
# Get Worker Shift
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-shift
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/shifts/{shift_id}
Returns a single shift assignment for a worker.
# Get Worker Shifts
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-shifts
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/shifts
Returns a paginated list of shifts assigned to a worker.
This endpoint supports pagination via `items_per_page` and `page` query parameters.
Use the `type` parameter to filter by `past` or `future` shifts. This can be combined with `start_date` and `end_date` for more specific date range filtering.
# Get Worker Tags
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-tags
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/tags
Returns all tags assigned to a worker.
# Get Worker Time Punch
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-time-punch
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/time-punches/{punch_id}
Returns a single time punch record for a worker.
# Get Worker Time Punches
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-time-punches
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/time-punches
Returns a paginated list of time punches for a worker.
This endpoint supports pagination via `items_per_page` and `page` query parameters.
Use the `date` parameter to filter punches for a specific date. When `date` is provided, it takes priority over `start_date` and `end_date`. Use `shift_id` to filter punches for a specific shift assignment.
# Get Workers
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-workers
api-reference/v01.12.00/openapi-v01.12.00.json GET /workers
Returns all workers matching the specified filters along with a totals breakdown by account status. This endpoint is not paginated β all matching workers are returned in a single response.
This endpoint returns **all** workers matching your filters in a single response β it is not paginated. The response includes a `totals` object with a breakdown of worker counts by account status (`activeTotal`, `inactiveTotal`, `pendingTotal`, `firstLoginTotal`, `onboardingTotal`, `allTotal`).
**Custom fields filter** β To filter by a custom field, use the query parameter format `customFields[{id}]={field_type}|{comparator}|{value}`. For example, `customFields[116]=dropdown|is|some_value` filters by custom field 116 (a dropdown) where the value equals `some_value`. Comparators vary by field type: text fields support basic matching, date fields support `is_before`, `is_after`, and `is`, and dropdown fields support `is`.
# Reject Worker Reimbursement
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/reject-worker-reimbursement
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/reimbursements/{reimbursement_id}/reject
Reject a pending worker reimbursement.
# Send Message
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/send-chat-message
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/chats/{chat_id}/messages
Sends a new message in a chat.
# Set Worker Document Viewable
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/set-worker-document-viewable
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/documents/{document_id}
Sets whether a worker can view a specific document.
Set `worker_viewable` to `1` to allow the worker to see this document, or `0` to hide it.
# Upload Worker Document
Source: https://docs.roostedhr.com/api-reference/v01.12.00/workers/upload-worker-document
api-reference/v01.12.00/openapi-v01.12.00.json POST /workers/{id}/documents
Uploads a document for a specific worker. Use `multipart/form-data` encoding. The maximum file size is 50 MB.
Upload files using `multipart/form-data` encoding. The maximum file size is **50 MB**.
# Changelog
Source: https://docs.roostedhr.com/changelog
Recent updates, improvements, and fixes across the Roosted platform
## July 2026
### New Features
* **Mobile admin** β Full admin capabilities now available on mobile. Create and edit events, assign workers to shifts, manage time punches, and communicate with your team β all from your phone. Supports both admin and worker modes with a single tap to switch between them.
### Scheduling
* **Multi-day event email grouping** β Update notifications for multi-day events are now grouped by day instead of sending a separate email for each day.
***
## June 2026
### New Features
* **Applicant Tracking System (ATS)** β A new built-in ATS for managing job applications directly within Roosted. Post positions, receive applications, and move candidates through customizable hiring pipelines β all without leaving the platform. Includes candidate profiles, status tracking, and pipeline stage management.
* **Day Punch Summary widget** β A new dashboard widget showing a real-time summary of time punches for the current day. See who has punched in, who is missing, and take action with inline approve, edit, and add operations. Navigate day-by-day to review past punch activity at a glance.
* **Punch audit log** β View a detailed history of all changes to time punches, including who made each edit and when, accessible from the time punch dialog.
* **Events Areas API** β New API endpoints for managing event areas (GET, PATCH, CREATE) in API v1.12.
### Improvements
* **Role default custom name** β When creating shifts, the custom name field now auto-fills with the role's configured default, saving time on repetitive setups.
* **Invite defaults** β Streamlined the shift invitation process with configurable defaults for confirmation dialogs and calendar ordering.
### Fixes
* **Linked shift conflicts** β When any day in a linked shift group has a scheduling conflict, the entire group is now correctly hidden from available shifts.
* **Duplicate client signature prevention** β Resolved a race condition that could create duplicate signature records when multiple requests arrived simultaneously.
* **Duplicate credential log entries** β Removed duplicate action log entries that appeared when updating worker credentials.
### Security
* **Email change protection** β Added CSRF protection to the email change flow to prevent unauthorized account email modifications.
***
## May 2026
### New Features
* **First shift notification system** β Workers now receive a notification before their very first shift with helpful onboarding information.
* **Event messaging** β Send and receive messages tied to specific events or orders, keeping communication organized and in context. Threads are visible to admins and clients in the portal, so both sides stay aligned without switching to email or separate chat tools.
* **Client portal selectable locations** β Admins can now restrict which saved locations appear when clients create orders in the portal, with per-client allowlists.
* **Advanced mode toggle** β A new setting in configuration reveals power-user options that are hidden by default, keeping the interface clean for everyday use.
### Improvements
* **Worker query performance** β Significantly faster worker list loading for large teams. Event statistics are now computed separately, cutting load times by more than half for accounts with thousands of workers.
* **Worker my-shifts page redesign** β Modernized layout with improved navigation and cleaner presentation of upcoming and past shifts.
* **Punch window feedback** β When workers try to punch in too early, the app now shows exactly how much time remains and automatically closes the dialog when the window opens.
### Fixes
* **Worker calendar sync** β Fixed an issue where calendar sync could fail to update for certain worker configurations.
* **Custom field eligibility** β Workers with null custom field values are now correctly evaluated against eligibility rules instead of being incorrectly excluded.
* **Shift comments** β Fixed shift comments not saving when updating jobs in the new job view.
* **White-label image uploads** β Brand image uploads now visually update immediately after saving.
***
## April 2026
### New Features
* **White-label platform** β Run Roosted under your own brand. Set up a custom domain with automatic SSL provisioning, upload your logo, and customize colors β your workers, clients, and admins see your brand on every screen. Covers the admin interface, client portal, mobile app, login and signup pages, password reset flows, and all outbound emails.
* **Custom dashboard** β A redesigned admin dashboard with configurable widgets: recent reviews, upcoming shifts, worker activity, and more. Drag and resize widgets to build the view that fits your workflow. Virtual list pagination keeps everything fast, even with thousands of records.
* **Internal changelog system** β Automated PR ingestion from GitHub with a curation interface for publishing release notes.
* **Job view preference** β Admins can now toggle between the classic and new job view layouts, with their preference saved across sessions.
### Improvements
* **Calendar multi-day events** β Multi-day events and orders now break down correctly in the calendar view, showing each day's shifts individually instead of as a single block.
* **Client portal order filtering** β Improved filtering options when browsing orders in the client portal.
* **Report formatting** β Updated report layouts and date handling for clearer exports.
* **Configuration page modernization** β Reorganized settings page with modular layout and improved discoverability.
### Fixes
* **White-label login redirect** β Users on custom domains now stay on their branded domain through the entire login flow instead of being redirected to the default domain.
* **Invite email delivery** β Fixed an issue where certain invitation emails were not being delivered.
* **Calendar and list view** β Multiple fixes to event display and filtering in both calendar and list view layouts.
* **Worked hours report** β Corrected calculation errors in the worked hours report.
* **Client order status** β Fixed incorrect status display for certain client orders.
***
## March 2026
### Improvements
* **Worker invite updates for job copying** β When copying jobs, worker invite settings now carry over correctly to the new job.
* **Client portal calendar** β Improved calendar view with better filtering and event display for client portal users.
* **Web punch source tracking** β Time punches made from the web interface are now correctly tagged with their source for audit purposes.
### Fixes
* **Event payroll distribution** β Fixed calculation in the event payroll distribution report.
* **Client order details** β Resolved missing orders and workers for single-day events in the client portal.