Added
Working Hours Policies API
1 day ago by ReadMe API
You can now read Regular Working Hours policies, see an employee's expected week, assign people to a shared policy, and set or remove custom hours through the Company Policies API.
A working hours policy is the expected week Job Schedule and Time Clock use: work days, time windows, and daily duration. Create the shared policy contents in the dashboard; use these endpoints to attach employees from an HRIS or WFM system. The Connecteam agent uses the same surface to help admins set expected hours during setup.
New Endpoints
GET /company-policies/v1/working-hours-policies— List shared policies, including disabled onesGET /company-policies/v1/users/USERID/working-hours— Get one employee's hours (shared policy, custom hours, or empty)PUT /company-policies/v1/users/USERID/working-hours— Create or replace custom hoursDELETE /company-policies/v1/users/USERID/working-hours— Remove custom hours. A shared assignment is keptPUT /company-policies/v1/working-hours-policies/{workingHoursPolicyId}/assignments— Assign up to 100 users at once viauserIdsDELETE /company-policies/v1/working-hours-policies/{workingHoursPolicyId}/assignments/USERID— Unassign a user from a shared policy
Key Features
- One configuration per user: a shared policy or custom hours, never both
- Immediate assign:
userIdsis all-or-nothing, max 100 IDs, noeffectiveDate - Multiple windows per day: iterate
timeRanges. Overnight work is two days, not one wrapping range - Connecteam agent: the agent uses these endpoints to look up policies and set expected hours during setup
Authentication
- API Key (
X-API-KEYheader), or - OAuth 2.0 with
company_policies.read,company_policies.write, orcompany_policies.delete
Requires the Schedule API plan limitation and Regular Working Hours to be enabled on the account.
For full details and examples, see the Working Hours Policies guide.
