Added
Scheduling Rule Policies API
8 days ago by ReadMe API
You can now list scheduling rule policies, see which rules apply to an employee, assign users in bulk, and delete a policy through the Company Policies API.
Scheduling rule policies are the labor-law and internal-policy guardrails Job Schedule enforces: weekly hour caps, rest between shifts, and shift-count limits. Create the policy contents in the dashboard; use these endpoints to attach employees from an HRIS or compliance system. The Connecteam agent uses the same surface to help admins attach the right policy during setup.
New Endpoints
GET /company-policies/v1/scheduling-rule-policies— List company policies and the rules in each one (enabled and disabled)GET /company-policies/v1/users/USERID/scheduling-rule-policies— Get the policies governing one employee, including custom profile rulesGET /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}/assignments— List who is assigned to a policyPUT /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}/assignments— Assign up to 100 users at once viauserIdsDELETE /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}— Delete a policy and all of its assignments
Key Features
- Rule details on the list: each policy returns its rule types, values,
preventClaim, and optional scheduler or shift filters - Employee lookup: one call answers which company policy and custom profile rules apply, including when both apply at once (strictest value wins)
- Bulk assign:
userIdsis all-or-nothing, max 100 unique IDs, and takes effect immediately (noeffectiveDate) - Company vs custom: assigning a company policy replaces the previous company assignment and leaves custom profile rules untouched
- Connecteam agent: the agent uses these endpoints to look up policies and attach people 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.
For full details and examples, see the Scheduling Rule Policies guide and the API Reference.
