# When I Work **Canonical:** https://apis.io/providers/when-i-work/ **Website:** https://wheniwork.com **APIs profiled:** 22 When I Work is an employee scheduling and workforce management platform serving over 200,000 workplaces in industries such as restaurants, retail, healthcare, and hospitality. The platform provides a REST API that enables developers and integration partners to manage shifts, schedules, users, time clock records, attendance, and team communication programmatically. API access is restricted to the Premium plan tier, which also includes webhook support and SAML/SSO capabilities. Authentication follows a token-based model where a private developer key and user credentials are exchanged for a bearer token used in subsequent requests. When I Work also publishes webhooks for real-time event notifications, making it suitable for building payroll, HR, and operations integrations. ## Kin Score — 43.7 / 100 (developing) Scored 2026-08-25 under rubric 0.14.0. Trend: flat (+0.0 from 43.7). | Facet | Score | |---|---| | Discoverability | 68.5 | | Contract Quality | 64.5 | | Governance | 9.8 | | Contract Governance | 9.8 | | Operational Transparency | 39.5 | | Developer Ergonomics | 14.3 | | Commercial Clarity | 57.9 | | Access Clarity | 57.9 | ## Agent readiness — 28.1 (agent-aware) | Dimension | Value | |---|---| | Spec Presence | yes | | Agentic Access | derived | | Reversibility Documented | no | | MCP Server | no | | Auth Clarity | bearer | | Idempotency | no | | Error Semantics | verified | | OpenAPI Examples | partial | | Rate Limit Signal | documented | | Event Surface Described | no | | Agent Skills | no | | Well Known Catalog | no | | Consent Identity | no | | Agent Card | no | | Dry Run Mode | no | | Delegated Identity | no | | Protected Resource Metadata | no | | Dynamic Client Registration | no | | Agentic Commerce | no | ## Access Paid (free trial) · Open access — onboarding: open, pricing: paid, trial: yes (confidence: high). ## APIs (22) - **When I Work Accounts API** — Accounts (aka Workplaces) are objects that define a business account with When I Work. Each user is associated with an account enabling them to access Shifts or other data. For ... - **When I Work Annotations API** — Annotations convey important information to all staff for the given schedules (locations) and date range. Any or none of the following tags may apply to an Annotation: * Time Of... - **When I Work Availabilities API** — Set your availability preferences to let your employer know when you prefer to work and when you prefer not to work. For more information about using Availabilities, visit the [... - **When I Work Import API** — The import API is used to import a variety of When I Work resources from user-provided CSV or Excel files. ### Import Types All available import types and their columns are list... - **When I Work OpenShift Requests API** — Shift Bidding, also called “OpenShift Requests”, is an option within an OpenShift that allows employees to express interest in the shift. Management can then view who has reques... - **When I Work Payrolls API** — Payrolls allows you to select a pay period date range and hours worked within that range. Default range if not supplied is today + 3 days. > Please note that payrolls cannot be ... - **When I Work Positions API** — Positions (aka, job or duty) are used to define labor allocation. Users can be tagged (associated) with one or more Positions. When I Work uses this association for shift eligib... - **When I Work Punch API** — A punch is an event where a user clocks in or clocks out. Punches can be managed to restrict where an employee can clock in/out and from what devices. If a user forgets to clock... - **When I Work Request Type API** — Types of time off that can be selected when submitting a time off request. For more information about using Time Off Requests, visit the [Help Center](https://help.wheniwork.com... - **When I Work Schedule Templates API** — Schedule templates allow you to create a daily or weekly schedule that is reusable. If your schedules are very similar from day to day or week to week, use a template to save ti... - **When I Work Schedules (Locations) API** — Schedules are logical groupings of users that are working together. Schedules can be physical offices with addresses or logical groups like departments. Users can be tagged (ass... - **When I Work Shift Break - Paid Rest API** — When the Attendance setting is enabled to Ask Employees About Paid Rest Breaks the feedback on whether or not breaks were taken is provided here. Note: This endpoint requires th... - **When I Work Shift Breaks API** — Two types of breaks are provided. First; Scheduled Shift Breaks are break records associated with scheduled shifts. Second; Shift Breaks are break records associated with time w... - **When I Work Shift Requests API** — If you’re unable to work one of your shifts, you can give it to one of your coworkers (drop the shift) or trade shifts with one of your coworkers (swap shifts). For more informa... - **When I Work Shift Templates (Blocks) API** — Shift templates save you time when you need to schedule shifts that have a consistent start and end time. Instead of manually entering in custom shift details one-by-one, shift ... - **When I Work Shifts API** — Shifts provide the basis for scheduling. Many other objects, including Schedules (aka Locations), Positions, Sites, Users, Tasks, and Tags all link through Shifts. For more info... - **When I Work Sites API** — Sites communicate additional information about a given shift to the recipient. Typical usage is when you schedule employees for shifts that are at different physical sites (addr... - **When I Work Swaps API** — The Swaps API from When I Work — 1 operation(s) for swaps. - **When I Work Time Off Requests API** — When you need to take time off from work, use When I Work to send the request to your manager for approval. Time off can be submitted as unpaid, paid (PTO), sick, or holiday. Fo... - **When I Work Times API** — Time records are a listing of the worked hours and can be select by date range. Records are sourced from timeclock terminal, web clock In/Out, mobile clock In/Out, timesheet edi... - **When I Work Timezones API** — Timezones for When I work workplaces including Olson ID - **When I Work Users API** — A person on the When I Work platform is associated with a two tier record. The persons email/password is associated to a person_id. For each Workplace the person belongs to a us... ## Agentic access (1) - **When I Work Agentic Access** — 119 operations · 71 acting ## Security (3) - **When I Work Authentication** — http · 1 scheme - **When I Work Domain Security** — TLSv1.3 · DMARC - **When I Work Trust Center** — SOC 2 ## Plans (1) - **When I Work Plans Pricing** ## Tags Employee Scheduling, Workforce Management, Time Tracking, Time Clock, Shift Management, Attendance, Team Messaging, Hourly Workers, Labor Forecasting, HR --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/providers/when-i-work/). Scores are computed from the provider's own public artifacts under a published rubric.