# Roosted HR API Documentation

## Docs

- [Getting Started](https://docs.roostedhr.com/api-reference/getting-started.md): Roosted HR Enterprise API reference
- [Create Announcement](https://docs.roostedhr.com/api-reference/v01.12.00/announcements/create-announcement.md): 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.
- [Get Announcement](https://docs.roostedhr.com/api-reference/v01.12.00/announcements/get-announcement.md): Returns a single announcement by ID, including its subject, message body, delivery channels, recipients, and status.
- [Get Announcements](https://docs.roostedhr.com/api-reference/v01.12.00/announcements/get-announcements.md): Returns a paginated list of announcements for your company, ordered by most recent first.
- [Create Area](https://docs.roostedhr.com/api-reference/v01.12.00/areas/create-area.md): Creates a new area. Areas can be organized hierarchically by setting a parent_id.
- [Delete Area](https://docs.roostedhr.com/api-reference/v01.12.00/areas/delete-area.md): Permanently deletes an area. Protected areas and areas with children cannot be deleted.
- [Edit Area](https://docs.roostedhr.com/api-reference/v01.12.00/areas/edit-area.md): Updates an area's name or position in the hierarchy.
- [Get Area](https://docs.roostedhr.com/api-reference/v01.12.00/areas/get-area.md): Returns a single area by its ID.
- [Get Areas](https://docs.roostedhr.com/api-reference/v01.12.00/areas/get-areas.md): Returns all areas for your company, including their hierarchical relationships.
- [Approve Client Order](https://docs.roostedhr.com/api-reference/v01.12.00/clients/approve-client-order.md): Approves a pending client portal order. Only orders with status `0` (pending) can be approved.
- [Create Client](https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client.md): Creates a new client. Only `client_name` is required.
- [Create Client Contact](https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client-contact.md): Creates a new contact for a specific client.
- [Create Client Rule](https://docs.roostedhr.com/api-reference/v01.12.00/clients/create-client-rule.md): 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.
- [Decline Client Order](https://docs.roostedhr.com/api-reference/v01.12.00/clients/decline-client-order.md): Declines a pending client portal order. Only orders with status `0` (pending) can be declined.
- [Delete Client](https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client.md): Permanently deletes a client by ID.
- [Delete Client Document](https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client-document.md): Permanently deletes a client document.
- [Delete Client Rule](https://docs.roostedhr.com/api-reference/v01.12.00/clients/delete-client-rule.md): Deletes a specific worker matching rule from a client.
- [Edit Client](https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client.md): Updates an existing client. The `client_name` field is required on every request.
- [Edit Client Contact](https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client-contact.md): Updates an existing client contact.
- [Edit Client Worker Status](https://docs.roostedhr.com/api-reference/v01.12.00/clients/edit-client-worker-status.md): Updates a worker's preference status for this client.
- [Get Client](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client.md): Returns a single client by ID.
- [Get Client Contact](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-contact.md): Returns a single contact by ID.
- [Get Client Contacts](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-contacts.md): Returns all contacts for a specific client.
- [Get Client Custom Fields with Values](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-custom-fields.md): Returns all custom fields and their values for a specific client.
- [Get Client Document](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-document.md): Returns a single document by ID.
- [Get Client Documents](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-documents.md): Returns all documents uploaded for a specific client.
- [Get Client Order](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-order.md): Returns a single client portal order by ID.
- [Get Client Orders](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-orders.md): Returns a paginated list of orders submitted through the client portal for a specific client.
- [Get Client Rules](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-rules.md): Returns all worker matching rules for a specific client, grouped by category (fields, credentials, has_tags, does_not_have_tags).
- [Get Client Worker Status](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-worker-status.md): Returns the preference status of a specific worker for this client.
- [Get Client Workers](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-client-workers.md): Returns all workers grouped by their preference status (preferred, normal, banned) for a specific client.
- [Get Clients](https://docs.roostedhr.com/api-reference/v01.12.00/clients/get-clients.md): Returns a paginated list of all clients for your company.
- [Invite Client by Email](https://docs.roostedhr.com/api-reference/v01.12.00/clients/invite-client.md): Sends a client portal invitation email to the client's primary contact email address. No request body is needed.
- [Set Client Custom Field Value](https://docs.roostedhr.com/api-reference/v01.12.00/clients/set-client-custom-field.md): Sets a value on an existing company-wide custom field for a specific client. This does not create a new field definition.
- [Upload Client Document](https://docs.roostedhr.com/api-reference/v01.12.00/clients/upload-client-document.md): Uploads a document for a specific client. Maximum file size is 50 MB.
- [Create Company Document](https://docs.roostedhr.com/api-reference/v01.12.00/company/create-company-document.md): This endpoint serves the purpose of creating a company document.
- [Delete Company Document](https://docs.roostedhr.com/api-reference/v01.12.00/company/delete-company-document.md): This endpoint serves the purpose of deleting company document based on unique document ID.
- [Delete Company Integration](https://docs.roostedhr.com/api-reference/v01.12.00/company/delete-company-integration.md): This endpoint serves the purpose of deleting a company integration.
- [Edit Company Info](https://docs.roostedhr.com/api-reference/v01.12.00/company/edit-company-info.md): This endpoint serves the purpose of modifying company information.
- [Get Company Document](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-document.md): This endpoint serves the purpose of fetching company document based on unique document ID.
- [Get Company Documents](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-documents.md): This endpoint serves the purpose of fetching company documents.
- [Get Company HR Info](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-hr-info.md): This endpoint serves the purpose of fetching company HR information.
- [Get Company Info](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-info.md): This endpoint serves the purpose of fetching company information.
- [Get Company Integration](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integration.md): This endpoint serves the purpose of fetching company integration based on unique integration ID.
- [Get Company Integrations](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integrations.md): This endpoint serves the purpose of fetching company integrations.
- [Get Company Integrations Count](https://docs.roostedhr.com/api-reference/v01.12.00/company/get-company-integrations-count.md): This endpoint serves the purpose of fetching total count of company integrations.
- [Regenerate Company Integration Secret Key](https://docs.roostedhr.com/api-reference/v01.12.00/company/regenerate-company-integration.md): This endpoint serves the purpose of regenerating the secret key for a company integration.
- [Set Up Company Integration](https://docs.roostedhr.com/api-reference/v01.12.00/company/set-up-company-integration.md): This endpoint serves the purpose of setting up a new company integration with a partner.
- [Update Company Integration](https://docs.roostedhr.com/api-reference/v01.12.00/company/update-company-integration.md): This endpoint serves the purpose of updating a company integration's configuration.
- [Edit Configuration](https://docs.roostedhr.com/api-reference/v01.12.00/configuration/edit-configuration.md): Updates a single configuration setting. Settings are identified by their category, subcategory, and item name.
- [Get Configuration](https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-configuration.md): Returns all configuration settings for your company, organized into five categories: shift options, worker interaction, worker communication, admin, and time tracking.
- [Get Countries](https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-countries.md): Returns all available countries. Use the country `id` when setting a worker's `country_id`.
- [Get Timezones](https://docs.roostedhr.com/api-reference/v01.12.00/configuration/get-timezones.md): Returns all available timezones. Use the timezone `id` when setting a company or location timezone.
- [Add Event Admin](https://docs.roostedhr.com/api-reference/v01.12.00/events/add-event-admin.md): Assigns an admin to an event.
- [Check if Shift is Full](https://docs.roostedhr.com/api-reference/v01.12.00/events/check-shift-full.md): Checks whether a shift has reached its staffing capacity.
- [Create Event](https://docs.roostedhr.com/api-reference/v01.12.00/events/create-event.md): Creates a new event.
- [Create Shift](https://docs.roostedhr.com/api-reference/v01.12.00/events/create-shift.md): Creates a new shift for an event.
- [Delete Event Admin](https://docs.roostedhr.com/api-reference/v01.12.00/events/delete-event-admin.md): Removes an admin from an event.
- [Delete Shift](https://docs.roostedhr.com/api-reference/v01.12.00/events/delete-shift.md): Deletes a shift from an event.
- [Edit Event](https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-event.md): Updates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.
- [Edit Shift](https://docs.roostedhr.com/api-reference/v01.12.00/events/edit-shift.md): Updates an existing shift. Only include the fields you want to change.
- [Get Event](https://docs.roostedhr.com/api-reference/v01.12.00/events/get-event.md): Returns details for a single event by ID.
- [Get Event Admins](https://docs.roostedhr.com/api-reference/v01.12.00/events/get-event-admins.md): Returns the list of admins assigned to an event.
- [Get Events](https://docs.roostedhr.com/api-reference/v01.12.00/events/get-events.md): Returns a paginated list of events for your company.
- [Get Shift](https://docs.roostedhr.com/api-reference/v01.12.00/events/get-shift.md): Returns details for a single shift by ID.
- [Get Event Shifts](https://docs.roostedhr.com/api-reference/v01.12.00/events/get-shifts.md): Returns all shifts for an event.
- [Search Events](https://docs.roostedhr.com/api-reference/v01.12.00/events/search-events.md): Searches events using a combination of filters. Returns paginated results.
- [Create Location](https://docs.roostedhr.com/api-reference/v01.12.00/locations/create-location.md): Creates a new location.
- [Delete Location](https://docs.roostedhr.com/api-reference/v01.12.00/locations/delete-location.md): Permanently deletes a location.
- [Edit Location](https://docs.roostedhr.com/api-reference/v01.12.00/locations/edit-location.md): Updates an existing location. Only include fields you want to change.
- [Get Location](https://docs.roostedhr.com/api-reference/v01.12.00/locations/get-location.md): Returns a single location by ID.
- [Get Locations](https://docs.roostedhr.com/api-reference/v01.12.00/locations/get-locations.md): Returns a paginated list of all locations.
- [Create Payroll Group](https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/create-payroll-group.md): Creates a new payroll group.
- [Delete Payroll Group](https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/delete-payroll-group.md): Soft-deletes a payroll group. The payroll group will no longer appear in listings but existing shifts are not affected.
- [Edit Payroll Group](https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/edit-payroll-group.md): Updates an existing payroll group. All fields (name, group_rows, locations) are required in the request body.
- [Get Payroll Group](https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/get-payroll-group.md): Returns a single payroll group by ID.
- [Get Payroll Groups](https://docs.roostedhr.com/api-reference/v01.12.00/payroll-groups/get-payroll-groups.md): Returns all payroll groups, sorted alphabetically by name.
- [Create Rate Card](https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/create-rate-card.md): Creates a new rate card with per-skillset billing and pay rate configuration.
- [Delete Rate Card](https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/delete-rate-card.md): 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.
- [Edit Rate Card](https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/edit-rate-card.md): Updates rate card billing and pay configuration. Does not allow renaming the rate card.
- [Get Rate Card](https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/get-rate-card.md): Returns a single rate card entry by ID.
- [Get Rate Cards](https://docs.roostedhr.com/api-reference/v01.12.00/rate-cards/get-rate-cards.md): Returns all rate cards with their per-skillset billing and pay rate configuration.
- [Create Skillset](https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/create-skillset.md): Creates a new skillset.
- [Delete Skillset](https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/delete-skillset.md): Soft-deletes a skillset. The skillset will no longer appear in listings but existing shifts are not affected.
- [Edit Skillset](https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/edit-skillset.md): Updates an existing skillset. Only include fields you want to change.
- [Get Skillset](https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/get-skillset.md): Returns a single skillset by ID.
- [Get Skillsets](https://docs.roostedhr.com/api-reference/v01.12.00/skillsets/get-skillsets.md): Returns a paginated list of all skillsets.
- [Get Worker Time Tracking Summary](https://docs.roostedhr.com/api-reference/v01.12.00/time-tracking/get-worker-time-tracking-summary.md): This endpoint serves the purpose of fetching worker time tracking summary based on unique worker UUID and date.
- [Create Wage Rule](https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/create-wage-rule.md): Creates a new wage rule.
- [Delete Wage Rule](https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/delete-wage-rule.md): Permanently deletes a wage rule.
- [Edit Wage Rule](https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/edit-wage-rule.md): Updates an existing wage rule.
- [Get Wage Rule](https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/get-wage-rule.md): Returns a single wage rule by ID.
- [Get Wage Rules](https://docs.roostedhr.com/api-reference/v01.12.00/wage-rules/get-wage-rules.md): Returns all wage rules for your company.
- [Add Transferred Workers](https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-transferred-workers.md): 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](https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-reimbursement.md): Add a reimbursement record for a worker.
- [Add Worker Tag](https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-tag.md): Adds an existing tag to a worker.
- [Add Worker Time Punch](https://docs.roostedhr.com/api-reference/v01.12.00/workers/add-worker-time-punch.md): Add a time punch for a worker.
- [Approve Worker Reimbursement](https://docs.roostedhr.com/api-reference/v01.12.00/workers/approve-worker-reimbursement.md): Approve a pending worker reimbursement.
- [Approve Worker Time Punch](https://docs.roostedhr.com/api-reference/v01.12.00/workers/approve-worker-time-punch.md): Approve a pending worker time punch.
- [Create Chat](https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-chat.md): Creates a new chat for a worker.
- [Create Worker](https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker.md): Creates a new worker profile. Only the worker name is required — all other fields are optional.
- [Create Worker Credential](https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-credential.md): Creates a credential record for a specific worker.
- [Create Worker Order](https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-order.md): 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.
- [Create Worker Tag](https://docs.roostedhr.com/api-reference/v01.12.00/workers/create-worker-tag.md): Creates a new global tag and assigns it to the specified worker. The tag becomes available to assign to any worker.
- [Delete Chat](https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-chat.md): Deletes a chat by worker ID and chat ID.
- [Delete Worker Credential](https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-credential.md): Soft-deletes a worker credential. The credential is marked as deleted but not permanently removed.
- [Delete Worker Document](https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-document.md): Soft-deletes a worker document. The document is marked as deleted but not permanently removed.
- [Delete Worker Tag](https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-tag.md): Removes a tag from a worker. Returns true on successful deletion.
- [Delete Worker Time Punch](https://docs.roostedhr.com/api-reference/v01.12.00/workers/delete-worker-time-punch.md): Delete a worker time punch.
- [Edit Chat](https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-chat.md): Updates a chat's name or members.
- [Edit Worker](https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker.md): Updates an existing worker profile. Only include the fields you want to change — all fields are optional.
- [Edit Worker Permissions](https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker-permissions.md): 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.
- [Edit Worker Time Punch](https://docs.roostedhr.com/api-reference/v01.12.00/workers/edit-worker-time-punch.md): Update a worker time punch.
- [Get Chat](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chat.md): Retrieves a specific chat by worker ID and chat ID.
- [Get Chat Messages](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chat-messages.md): Retrieves a paginated list of messages in a chat. Supports cursor-based pagination for infinite scroll.
- [Get Chats](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-chats.md): Retrieves a paginated list of active chats for a worker. Supports cursor-based pagination for infinite scroll.
- [Get Transferred Workers](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-transferred-workers.md): Returns all transferred workers for the authenticated company.
- [Get Unread Messages Count](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-unread-messages-count.md): Retrieves the total unread messages count across all chats for a worker.
- [Get Worker](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker.md): Returns the full profile for a single worker by their unique ID.
- [Get Worker Availability](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-availability.md): Returns availability entries for a specific worker from today forward.
- [Get Worker Credential](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-credential.md): Returns a single credential record for a specific worker.
- [Get Worker Credentials](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-credentials.md): Returns a paginated list of credentials for a specific worker. Optionally filter by credential type.
- [Get Worker Document](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-document.md): Returns a single document for a specific worker.
- [Get Worker Documents](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-documents.md): Returns all documents uploaded for a specific worker.
- [Get Worker Limits](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-limits.md): Returns the shift and hour limits configured for a specific worker.
- [Get Worker Order](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-order.md): Returns a single order for a specific worker.
- [Get Worker Orders](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-orders.md): Returns a paginated list of orders for a specific worker.
- [Get Worker Permissions](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-permissions.md): Returns the permission flags for a specific worker, including admin/owner status and granular module-level permissions.
- [Get Worker Reimbursement](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-reimbursement.md): Returns a single reimbursement record for a worker.
- [Get Worker Reimbursements](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-reimbursements.md): Returns a paginated list of reimbursements for a worker.
- [Get Worker Shift](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-shift.md): Returns a single shift assignment for a worker.
- [Get Worker Shifts](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-shifts.md): Returns a paginated list of shifts assigned to a worker.
- [Get Worker Tags](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-tags.md): Returns all tags assigned to a worker.
- [Get Worker Time Punch](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-time-punch.md): Returns a single time punch record for a worker.
- [Get Worker Time Punches](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-worker-time-punches.md): Returns a paginated list of time punches for a worker.
- [Get Workers](https://docs.roostedhr.com/api-reference/v01.12.00/workers/get-workers.md): 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.
- [Reject Worker Reimbursement](https://docs.roostedhr.com/api-reference/v01.12.00/workers/reject-worker-reimbursement.md): Reject a pending worker reimbursement.
- [Send Message](https://docs.roostedhr.com/api-reference/v01.12.00/workers/send-chat-message.md): Sends a new message in a chat.
- [Set Worker Document Viewable](https://docs.roostedhr.com/api-reference/v01.12.00/workers/set-worker-document-viewable.md): Sets whether a worker can view a specific document.
- [Upload Worker Document](https://docs.roostedhr.com/api-reference/v01.12.00/workers/upload-worker-document.md): Uploads a document for a specific worker. Use `multipart/form-data` encoding. The maximum file size is 50 MB.
- [How does Roosted bill?](https://docs.roostedhr.com/guides/billing/how-does-roosted-bill.md): How will you be charged for our service?
- [Client Orders](https://docs.roostedhr.com/guides/clients/client-orders.md): How you clients can place their orders?
- [Client Portal](https://docs.roostedhr.com/guides/clients/client-portal.md)
- [Client Signature](https://docs.roostedhr.com/guides/clients/client-signature.md): How to use the Client Signature feature to obtain signatures from clients or senior staff members at the end of an event?
- [Clients](https://docs.roostedhr.com/guides/clients/clients.md): Clients and how to manage their profiles.
- [Announcement & Chats](https://docs.roostedhr.com/guides/communication/announcement-chats.md): Announcements & Chats for the best communication with your workers.
- [Calendar Sync](https://docs.roostedhr.com/guides/communication/calendar-sync.md): Sync your Google, Apple or other calendar with Roosted for even better experience!
- [Communication](https://docs.roostedhr.com/guides/communication/communication.md): Discover multiple ways that you or the system can communicate with your workers.
- [Event Chats](https://docs.roostedhr.com/guides/communication/event-chats.md): Event Chats are an easy way of forwarding information to your workers scheduled for an event.
- [Push Notifications](https://docs.roostedhr.com/guides/communication/push-notifications.md): Enable push notifications from out app!
- [Shift Update Notification](https://docs.roostedhr.com/guides/communication/shift-update-notification.md): Control when and how your workers are notified about updates to shifts for which they’re scheduled.
- [Availability & Time Off - Settings](https://docs.roostedhr.com/guides/configuration/availability-time-off-settings.md): How to manage your workers time off and availability?
- [Bailout Settings](https://docs.roostedhr.com/guides/configuration/bailout-settings.md): How to adjust your Bailout settings through Roosted.
- [Client Signature - Settings](https://docs.roostedhr.com/guides/configuration/client-signature-settings.md): Adjust your Client Signature to receive signing approval on an event from either a physical client or a senior staff member.
- [Comment Templates](https://docs.roostedhr.com/guides/configuration/comment-templates.md)
- [Communication Center](https://docs.roostedhr.com/guides/configuration/communication-center.md): Workers communication - how to gain the most of it?
- [Company Information](https://docs.roostedhr.com/guides/configuration/company-information.md): What data should you enter about your company and how?
- [Configuration Module](https://docs.roostedhr.com/guides/configuration/configuration-module.md): All the possibilities that Roosted offers to you.
- [Configuration Settings](https://docs.roostedhr.com/guides/configuration/configuration-settings.md): How to set up your account so it meets all your needs? All the possibilities explained.
- [Coworker Display](https://docs.roostedhr.com/guides/configuration/coworker-display.md): Understanding Coworker Display in Roosted
- [Custom Account Messages](https://docs.roostedhr.com/guides/configuration/custom-account-messages.md): Message your worker will receive to inform them about disabling their account.
- [Custom Fields](https://docs.roostedhr.com/guides/configuration/custom-fields.md): Personalise your needs and information about workers, events or clients with Custom Fields by your choice.
- [Custom Legal Acknowledgement](https://docs.roostedhr.com/guides/configuration/custom-legal-acknowledgement.md): The feature allows you to require workers to provide their agreement or acknowledgment  when they punch out of a shift.
- [Geo-fencing](https://docs.roostedhr.com/guides/configuration/geo-fencing.md): Geo-Fencing in Time Tracking
- [Integrations](https://docs.roostedhr.com/guides/configuration/integrations.md): How do you integrate external ATS with Roosted?
- [Invite to Work - Settings](https://docs.roostedhr.com/guides/configuration/invite-to-work-settings.md): Adjusting Your Invite to Work Settings
- [Multiple Shifts Per Day](https://docs.roostedhr.com/guides/configuration/multiple-shifts-per-day.md): Can my workers work many shifts per one day?
- [Reimbursement - Settings](https://docs.roostedhr.com/guides/configuration/reimbursement-settings.md): How to configure your reimbursement settings.
- [Reviews and Stars Visibility](https://docs.roostedhr.com/guides/configuration/reviews-and-stars-visibility.md): Control who sees the ratings of your workers.
- [Shift Check In Bot - Settings](https://docs.roostedhr.com/guides/configuration/shift-check-in-bot-settings.md): Set up the most convenient bot - it will manage your workers communication for you!
- [Shift Equalizer](https://docs.roostedhr.com/guides/configuration/shift-equalizer.md): Roosted will balance your workers between shifts when you have multiple shifts on the same day.
- [Shift Publishing Settings](https://docs.roostedhr.com/guides/configuration/shift-publishing-settings.md): Settings related to publishing your shifts.
- [Shift Update Notification - Settings](https://docs.roostedhr.com/guides/configuration/shift-update-notification-settings.md): What is the best way to set up your shift notifications?
- [Sign-Up Bot - Settings](https://docs.roostedhr.com/guides/configuration/sign-up-bot-settings.md)
- [Silence / Testing Mode](https://docs.roostedhr.com/guides/configuration/silence-testing-mode.md): Testing mode - how to use it and what is it's purpose?
- [Skillsets](https://docs.roostedhr.com/guides/configuration/skillsets.md): What are the skillsets and how are they used?
- [Text Message Notification - Options](https://docs.roostedhr.com/guides/configuration/text-message-notification-options.md): How to manage your workers communications via Text messages.
- [Venues](https://docs.roostedhr.com/guides/configuration/venues.md): Adding, Editing, and Deleting Locations.
- [Worker Calendar Settings](https://docs.roostedhr.com/guides/configuration/worker-calendar-settings.md): Adjusting Worker Calendar Settings in Roosted
- [Worker Hours Display](https://docs.roostedhr.com/guides/configuration/worker-hours-display.md): Workers to view their tracked hours and their future scheduled hours.
- [Admin/Owner Dashboard](https://docs.roostedhr.com/guides/dashboard/adminowner-dashboard.md): Admin dashboard and what it offers!
- [Calendar Sync - Workers](https://docs.roostedhr.com/guides/desktop/calendar-sync-workers.md): How to sync your calendar with Roosted app?
- [Homepage (Desktop)](https://docs.roostedhr.com/guides/desktop/homepage-desktop.md): How to navigate through your Roosted account?
- [Pending Reviews - Desktop](https://docs.roostedhr.com/guides/desktop/pending-reviews-desktop.md): Reviews of your worker and colleagues - how do they work?
- [View your Past Shifts](https://docs.roostedhr.com/guides/desktop/view-your-past-shifts.md): Past shifts and ratings - how to manage them?
- [Document Signing](https://docs.roostedhr.com/guides/documents/document-signing.md): Get your documents signed within the app.
- [Document Uploading](https://docs.roostedhr.com/guides/documents/document-uploading.md): How to upload documents into events and workers profiles?
- [Available Shifts (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/available-shifts-desktop-mobile-app.md): Logging in, picking up new shifts, and viewing your current and upcoming shifts with ease.
- [Bailout (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/bailout-desktop-mobile-app.md): How to bailout from the shift and what are the possible consequences?
- [Blogs (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/blogs-desktop-mobile-app.md): Blogs as new's and updates from your company.
- [Check-In](https://docs.roostedhr.com/guides/general/check-in.md): How to use Check-In feature on Desktop & Mobile App
- [Company Documents (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/company-documents-desktop-mobile-app.md): Extra information added by your place of work.
- [Logging in for the 1st time (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/logging-in-for-the-1st-time-desktop-mobile-app.md): How to log in and what are the first steps to set up your Roosted account?
- [Next Shifts / Current Shifts](https://docs.roostedhr.com/guides/general/next-shifts-current-shifts.md): Upcoming shifts in desktop and app view.
- [Notifications, Announcements & Chat (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/notifications-announcements-chat-desktop-mobile-app.md): Easier communication with your workplace!
- [Office Hours and Support Availability](https://docs.roostedhr.com/guides/general/office-hours-and-support-availability.md): When we’re here to assist you.
- [Pending Document Signing Requests (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/pending-document-signing-requests-desktop-mobile-app.md): Sign and submit documents requested by your company: handbook, policies and procedures, and more!
- [Reset/Change your password](https://docs.roostedhr.com/guides/general/resetchange-your-password.md): Changing forgotten password in your Roosted worker account.
- [Shift Visibility](https://docs.roostedhr.com/guides/general/shift-visibility.md): How to configure how far out workers can see open shifts?
- [Viewing & Submitting Availability (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/viewing-submitting-availability-desktop-mobile-app.md): How to view & submit availability on both the desktop & mobile app.
- [Worker Profile (Desktop & Mobile App)](https://docs.roostedhr.com/guides/general/worker-profile-desktop-mobile-app.md): Viewing and editing your personal profile on the Desktop & Mobile App
- [Getting started with Roosted!](https://docs.roostedhr.com/guides/getting-started/getting-started-with-roosted.md): Get to know Roosted and begin scheduling!
- [Need a hand?](https://docs.roostedhr.com/guides/getting-started/need-a-hand.md): How to contact Roosted team?
- [What's next?](https://docs.roostedhr.com/guides/getting-started/whats-next.md): How to get the most out of Roosted?
- [App Troubleshooting](https://docs.roostedhr.com/guides/mobile/app-troubleshooting.md): Experiencing problems with your Roosted app?
- [Downloading the Mobile App](https://docs.roostedhr.com/guides/mobile/downloading-the-mobile-app.md): How to download and set up the Roosted app?
- [Payroll Groups](https://docs.roostedhr.com/guides/payroll/payroll-groups.md): What is a Payroll Group and where can you adjust it?
- [QuickBooks Support](https://docs.roostedhr.com/guides/payroll/quickbooks-support.md): Exporting Time Tracking Data to QuickBooks
- [Wage Types](https://docs.roostedhr.com/guides/payroll/wage-types.md): What are the types of wages you can use for your workers in Roosted?
- [Event Reviewer](https://docs.roostedhr.com/guides/reviews/event-reviewer.md): Review your events and workers for the better results!
- [Event Reviews & Feedback](https://docs.roostedhr.com/guides/reviews/event-reviews-feedback.md): How to rate your workers and how will it impact them?
- [Highly rated workers could have a low star ranking](https://docs.roostedhr.com/guides/reviews/highly-rated-workers-could-have-a-low-star-ranking.md): Why my good workers have low ratings?
- [How Do Reviews Affect My Workers](https://docs.roostedhr.com/guides/reviews/how-do-reviews-affect-my-workers.md): Good and bad reviews - how will they impact my workers?
- [Star Ratings](https://docs.roostedhr.com/guides/reviews/star-ratings.md)
- [Agency Placeholders](https://docs.roostedhr.com/guides/scheduling/agency-placeholders.md): Using Agency Placeholders in Your Scheduling Process
- [Alternates](https://docs.roostedhr.com/guides/scheduling/alternates.md): How to set up a Plan B for your events.
- [Approving Shift Requests](https://docs.roostedhr.com/guides/scheduling/approving-shift-requests.md): How to approve shift requests?
- [Bailouts](https://docs.roostedhr.com/guides/scheduling/bailouts.md): Bailouts and how your workers can resign from the shift.
- [Calendar View](https://docs.roostedhr.com/guides/scheduling/calendar-view.md): What are the perks of the Calendar view?
- [Calendar View Search & Filtering Options](https://docs.roostedhr.com/guides/scheduling/calendar-view-search-filtering-options.md): How to filter events in the calendar view?
- [Copying Events](https://docs.roostedhr.com/guides/scheduling/copying-events.md): If you have recurring events or shifts, it is very simple to copy these to multiple days.
- [Deleting Shifts & Events](https://docs.roostedhr.com/guides/scheduling/deleting-shifts-events.md): How to permanently delete a shift or event in Roosted?
- [Editing An Event](https://docs.roostedhr.com/guides/scheduling/editing-an-event.md): How to edit your event in various views offered by Roosted.
- [Event Tags](https://docs.roostedhr.com/guides/scheduling/event-tags.md): How to tag your events for better filtering.
- [Grid View](https://docs.roostedhr.com/guides/scheduling/grid-view.md): Perks of using the Grid view - another possibility of seeing your events.
- [Linked Events](https://docs.roostedhr.com/guides/scheduling/linked-events.md): How to link events in Roosted?
- [Main Event Page](https://docs.roostedhr.com/guides/scheduling/main-event-page.md): What are the features of it?
- [Request Manager](https://docs.roostedhr.com/guides/scheduling/request-manager.md)
- [Rules](https://docs.roostedhr.com/guides/scheduling/rules.md): Personalise each shift by workers' specific rules!
- [Scheduling](https://docs.roostedhr.com/guides/scheduling/scheduling.md): Different ways of scheduling your events in Roosted!
- [Shift Check-In Bot](https://docs.roostedhr.com/guides/scheduling/shift-check-in-bot.md): How your employers can check in into a shift?
- [Shift Limits](https://docs.roostedhr.com/guides/scheduling/shift-limits.md): How to set hours and shift limits across your company or on individual workers.
- [Shift Publishing](https://docs.roostedhr.com/guides/scheduling/shift-publishing.md): When is the shift ready to be published?
- [Shift Templates](https://docs.roostedhr.com/guides/scheduling/shift-templates.md): Templates that you can create to help speed up your scheduling process.
- [Side By Side View](https://docs.roostedhr.com/guides/scheduling/side-by-side-view.md): Side by side explained!
- [Spreadsheet View](https://docs.roostedhr.com/guides/scheduling/spreadsheet-view.md): Compare even the smallest differences in the most detailed view in Roosted.
- [Time Off Manager](https://docs.roostedhr.com/guides/time-off/time-off-manager.md): How to approve or reject Time Off requests of your workers?
- [Time Off Requests](https://docs.roostedhr.com/guides/time-off/time-off-requests.md): 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?
- [Event Time Tracking Manager](https://docs.roostedhr.com/guides/time-tracking/event-time-tracking-manager.md): What the Event Time Tracking Manager is and how it can be used to easily punch your workers in and out.
- [Pre Punch Questionnaire](https://docs.roostedhr.com/guides/time-tracking/pre-punch-questionnaire.md): Viewing and Editing the Pre-Punch Questionnaire
- [Reimbursements](https://docs.roostedhr.com/guides/time-tracking/reimbursements.md): Pay back your workers for job related expenses.
- [Time Punch Settings](https://docs.roostedhr.com/guides/time-tracking/time-punch-settings.md): Adjust your Time Punch Settings
- [Time Punches](https://docs.roostedhr.com/guides/time-tracking/time-punches.md): Track the hours worked, for better control of wages as part of Time Tracking.
- [Time Tracking Filters & Pending Punches](https://docs.roostedhr.com/guides/time-tracking/time-tracking-filters-pending-punches.md): Time Tracking Filters to manage time punches and address issues
- [Time Tracking Module](https://docs.roostedhr.com/guides/time-tracking/time-tracking-module.md): Time Tracking Module and how it can streamline your pre-payroll processing.
- [Admin Status Removed / Features Disabled / Premium Only](https://docs.roostedhr.com/guides/troubleshooting/admin-status-removed-features-disabled-premium-only.md): Sudden changes or lack of access on your account? Check this information!
- [Closing your account](https://docs.roostedhr.com/guides/troubleshooting/closing-your-account.md): How to close your Roosted account?
- [Trouble Logging In?](https://docs.roostedhr.com/guides/troubleshooting/trouble-logging-in.md): Basic troubleshooting to help you solve basic issues.
- [Why Can't a Worker See Certain Shifts?](https://docs.roostedhr.com/guides/troubleshooting/why-cant-a-worker-see-certain-shifts.md): Who gets to see the shifts first?
- [You see code or error?](https://docs.roostedhr.com/guides/troubleshooting/you-see-code-or-error.md): Clearing Browsing Data: A Quick Guide to Troubleshooting
- [Worker Calendar](https://docs.roostedhr.com/guides/worker-help/worker-calendar.md): How does the calendar look from workers side?
- [Activating a Worker](https://docs.roostedhr.com/guides/workers/activating-a-worker.md): Activating your workers profile and making them able to work.
- [Anytime Punches](https://docs.roostedhr.com/guides/workers/anytime-punches.md): Flexible Time Tracking for Trusted Workers
- [Areas](https://docs.roostedhr.com/guides/workers/areas.md): What are areas and how are they used?
- [Availability & Time Off](https://docs.roostedhr.com/guides/workers/availability-time-off.md): How to approve or reject Time Off requests of your workers?
- [Editing a Worker Profile](https://docs.roostedhr.com/guides/workers/editing-a-worker-profile.md): Workers module and editing the profile of the worker from the admin's view.
- [Giving Admin and Owner permissions](https://docs.roostedhr.com/guides/workers/giving-admin-and-owner-permissions.md): How to give some of your workers more power in the app?
- [Importing Workers](https://docs.roostedhr.com/guides/workers/importing-workers.md): How to import your workers file directly to your Roosted account?
- [Inactivating a Worker](https://docs.roostedhr.com/guides/workers/inactivating-a-worker.md): How to inactivate your worker you don't want to offer shifts to anymore?
- [Manually Creating New Workers](https://docs.roostedhr.com/guides/workers/manually-creating-new-workers.md): How do you create new workers manually?
- [Onboarding Workers](https://docs.roostedhr.com/guides/workers/onboarding-workers.md): How to onboard your imported workers?
- [Worker Import Template](https://docs.roostedhr.com/guides/workers/worker-import-template.md): How to use the Worker Import Template
- [Worker Module - Filters](https://docs.roostedhr.com/guides/workers/worker-module-filters.md): How to filter your workers foe easier search?
- [Worker Profile - Desktop](https://docs.roostedhr.com/guides/workers/worker-profile-desktop.md): Viewing and editing your personal profile on the Desktop & Mobile Browser.
- [Worker Profile - Mobile App](https://docs.roostedhr.com/guides/workers/worker-profile-mobile-app.md): Viewing and editing your personal profile on the Mobile App
- [Worker Self Sign-up](https://docs.roostedhr.com/guides/workers/worker-self-sign-up.md): How your workers can register to work with you through Roosted?
- [Worker Tags](https://docs.roostedhr.com/guides/workers/worker-tags.md): What is the purpose of tags and how to use them?
- [Worker Transfers](https://docs.roostedhr.com/guides/workers/worker-transfers.md): How to transfer workers?
- [Workers Module](https://docs.roostedhr.com/guides/workers/workers-module.md): Create, view, and sort your staff.
- [Direct Shift Assignment](https://docs.roostedhr.com/guides/workflows/direct-shift-assignment.md): How to directly assign workers to your shifts?
- [Invite to work](https://docs.roostedhr.com/guides/workflows/invite-to-work.md): How to use invite to work feature?
- [Preferred & Banned Workers](https://docs.roostedhr.com/guides/workflows/preferred-banned-workers.md): How to set up workers that are preferred to work with your customers?
- [Shift Request](https://docs.roostedhr.com/guides/workflows/shift-request.md): What are shift requests?
- [Shift Sign-Up](https://docs.roostedhr.com/guides/workflows/shift-sign-up.md): How to allow your workers to sign up for available shifts?
- [Sign Up Bot](https://docs.roostedhr.com/guides/workflows/sign-up-bot.md)
- [Workflows](https://docs.roostedhr.com/guides/workflows/workflows.md): How can you add a worker to a shift? There are multiple ways!

## OpenAPI Specs

- [openapi-v01.12.00](https://docs.roostedhr.com/api-reference/v01.12.00/openapi-v01.12.00.json)