Getting Started with WorkWhile
This guide introduces the WorkWhile Labor API and explains what data is available and how it’s typically used.
Overview
The WorkWhile Labor API provides read-only access to workforce data for your organization. It is intended for systems that need to automatically retrieve information about scheduled work and how it is fulfilled.
Using the API, you can fetch data about:
- shifts
- positions
- locations
All data reflects the current state of the WorkWhile platform.
Core Concepts
Shifts
A shift represents a scheduled job opportunity. Shift data includes timing, pay information, associated location and position, and worker assignment details.
Shifts are the primary unit for understanding when work is scheduled and how it is staffed.
Locations
A location represents the physical place where work occurs. Locations include identifying and address information and are associated with a specific company.
Positions
A position describes the type of work being performed during a shift, including the role name and related details.
Using the API
The Labor API is designed for data retrieval only. It does not support creating, updating, or managing shifts, positions, or locations.
Most integrations use the API to:
- retrieve lists of shifts, positions, or locations
- fetch detailed data for a specific resource
- periodically sync data into reporting or analytics systems
Updated 14 days ago